-
Notifications
You must be signed in to change notification settings - Fork 284
docs.fsharp.org? #995
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
I'd be happy to work on this. |
@IanWitham i will create a new repo docs.fsharp.org and give you access |
The CNAME mapping is not yet in place |
The site and domains are all setup and should be functioning now. The docs/ folder (https://github.com/fsharp/docs.fsharp.org/tree/main/docs) is now published to https://docs.fsharp.org properly |
Please take a look at https://github.com/fsharp/docs.fsharp.org/wiki and let me know your thoughts. |
Shall we include repl with docs? So people can try snippets? We can employ Fable (which can sometimes lag behind a tiny bit), or we can try deploying repl as wasm containers or something. I can assist with integrating it. |
I propose we keep the sources of the markdown spec in The spec content still needs a lot of hard work on the content, namely on integrating the RFCs. This will need discussions quite differerent from those needed in To move |
Would a submodule make sense here? |
I've spoken with @ReedCopsey and if we like he can make the DNS changes needed to activate https://docs.fsharp.org
However we'd need to decide what docs can really go there. I'll write some notes about what I think makes sense, if someone wants to tackle this
The main docs for F# are the ones listed here: https://learn.microsoft.com/dotnet/fsharp/ and whose source is part of the .NET docs (https://github.com/dotnet/docs). Although relying on the .NET docs to host and publish the F# docs is a bit annoying (e.g. the Microsoft branding and advertising is frustrating), it's not realistic for the F# community to host all those docs instead. The real question is about the important docs that are "external" to the .NET docs and are in this org,
The .NET docs site links to these. Do we want to move the first two to docs.fsharp.org URL?
To do this we would need a single repo https://github.com/fsharp/fsharp-docs that would contain the CNAME for the DNS entry and would combine the material in
docs.fsharp.org/spec
--> the material now at https://fsharp.org/specs/language-specdocs.fsharp.org/spec/markdown
--> the material now at https://github.com/fsharp/fslang-specdocs.fsharp.org/reference/...
--> the material now at https://fsharp.github.io/fsharp-core-docsdocs.fsharp.org/compiler/...
--> the material now at https://fsharp.github.io/fsharp-compiler-docs/The front page
docs.fsharp.org
would minimally need a search experience, see search on https://fsharp.github.io/fsharp-core-docs/ for example. Other improvements would have to come my improving the toolsfsdocs
(https://fsprojects.github.io/FSharp.Formatting/) which would continue to be used to generate at least the core docs.The text was updated successfully, but these errors were encountered: