Skip to content

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

Open
dsyme opened this issue Apr 8, 2025 · 9 comments
Open

docs.fsharp.org? #995

dsyme opened this issue Apr 8, 2025 · 9 comments

Comments

@dsyme
Copy link
Contributor

dsyme commented Apr 8, 2025

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

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 tools fsdocs (https://fsprojects.github.io/FSharp.Formatting/) which would continue to be used to generate at least the core docs.

@IanWitham
Copy link
Contributor

I'd be happy to work on this.

@dsyme
Copy link
Contributor Author

dsyme commented Apr 8, 2025

@IanWitham i will create a new repo docs.fsharp.org and give you access

@dsyme
Copy link
Contributor Author

dsyme commented Apr 9, 2025

Created! https://github.com/fsharp/docs.fsharp.org

@dsyme
Copy link
Contributor Author

dsyme commented Apr 9, 2025

The CNAME mapping is not yet in place

@ReedCopsey
Copy link
Contributor

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

@IanWitham
Copy link
Contributor

Please take a look at https://github.com/fsharp/docs.fsharp.org/wiki and let me know your thoughts.

@vzarytovskii
Copy link
Collaborator

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.

@Martin521
Copy link

Please take a look at https://github.com/fsharp/docs.fsharp.org/wiki and let me know your thoughts.

I propose we keep the sources of the markdown spec in fsharp/fslang-spec, in the same way as the (real) sources for the core lib documentation stay in dotnet/fsharp (as XML comments in the lib sources).

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 fsharp/docs.fsharp.org.

To move fsharp/fsharp-core-docs probably makes more sense, as it would be an intermediate step between the sources and the new site.

@ReedCopsey
Copy link
Contributor

Would a submodule make sense here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants