fsharp / fsharp/fsharp.org

docs.fsharp.org?

未关闭
#995 9 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TeX
星标
311
派生
291
PR 合并指标
30 天内没有已合并 PR

描述

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](https://fsharp.org/specs/language-spec/) and proto markdown (https://github.com/fsharp/fslang-spec)
* [F# library reference](https://fsharp.github.io/fsharp-core-docs) with source at https://github.com/fsharp/fsharp-core-docs
* [F# RFCs](https://github.com/fsharp/fslang-design)
* [F# Compiler docs](https://github.com/fsharp/fsharp-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-spec
* `docs.fsharp.org/spec/markdown` --> the material now at https://github.com/fsharp/fslang-spec
* `docs.fsharp.org/reference/...` --> the material now at https://fsharp.github.io/fsharp-core-docs
* `docs.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.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。