fsharp / fsharp/fsharp-core-docs

Move to docs.fsharp.org?

Open
#76 4 comments 9 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
37
Forks
20
Avg merge
6m
Merged PRs (30d)
1

Description

I'd like us to consider working with the FSSF to move https://fsharp.github.io/fsharp-core-docs/ to

https://docs.fsharp.org/reference

As you know, Microsoft and the .NET Foundation host the F# language docs. However the FSharp.Core docs are generated and hosted by the community . This means we have:

https://docs.microsoft.com/dotnet/fsharp/ -- primary F# docs landing page, e.g. Google search for "F# docs"
https://fsharp.github.io/fsharp-core-docs/ -- FSharp.Core docs

There are links across from one to the other. This split structure is not ideal but we have to live with it for now.

I would like us to make the second URL shorter and more canonical, in particular should we utilise docs.fsharp.org to start to host community generated portions of documentation. This would initially mean having this:

https://docs.microsoft.com/dotnet/fsharp/ -- primary F# docs landing page, e.g. Google search for "F# docs"
https://docs.fsharp.org/reference -- FSharp.Core docs

One advantage here is that the canonicals at least for an eventual unified set of docs pages at https://docs.fsharp.org. (We can't have this immediately as it would mean moving the language docs from Microsoft and the .NET Foundation, which would be expensive and cause a maintenance problem). Another advantage is that the FSSF now has the option host whatever additional documentation it likes at https://docs.fsharp.org, though I'm not aware of anything it wants to host. The disadvantage is that people might expect https://docs.fsharp.org to contain all docs for F#.

Best
Don

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.