docs.fsharp.org?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github, markdown
- Domain
- documentation
Research direction
Start by reviewing the proposed fsharp-docs repository structure, the existing fslang-spec, fsharp-core-docs, and fsharp-compiler-docs repositories, and the current fsharp.github.io/fsharp-core-docs search experience. Check the CNAME, existing links, and redirect requirements described in the issue. Done would require an agreed scope and plan for the consolidated docs site.
Written by the indexing model from the issue text.
Description
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,
- F# language specification and proto markdown (https://github.com/fsharp/fslang-spec)
- F# library reference with source at https://github.com/fsharp/fsharp-core-docs
- F# RFCs
- F# Compiler docs
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 content at https://fsharp.github.io/fsharp-core-docs would all need to be replaced by deep redirects to docs.fsharp.org/reference/... There are a lot of links to that current site.
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.
- Dominant language
- TeX
- Stars
- 311
- Forks
- 291
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from fsharp/fsharp.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
fsharp/fsharp.org#1026 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
fsharp/fsharp.org#1021 · 2 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
fsharp/fsharp.org#1024 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 58/100
fsharp/fsharp.org#1023 · 2 comments ·
-
N/A Open
Difficulty 5/5 Over a week Newbie friendliness 1/100
fsharp/fsharp.org#1019 ·
All issues in fsharp/fsharp.org
Similar issues
-
triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
feature pydanty:is-working
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pydantic/pydantic-ai#8647 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100