docs.fsharp.org?
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- github, markdown
調査の方向性
まず、提案されている fsharp-docs リポジトリの構成、既存の fslang-spec、fsharp-core-docs、fsharp-compiler-docs リポジトリ、および現在の fsharp.github.io/fsharp-core-docs の検索エクスペリエンスを確認します。CNAME、既存のリンク、この issue に記載されているリダイレクト要件を確認します。統合されたドキュメントサイトのスコープと計画について合意できていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- TeX
- スター
- 311
- フォーク
- 291
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
fsharp/fsharp.org のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
fsharp/fsharp.org#1026 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
fsharp/fsharp.org#1021 · コメント 2 件 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
fsharp/fsharp.org#1024 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 58/100
fsharp/fsharp.org#1023 · コメント 2 件 ·
-
N/A オープン
難易度 5/5 1週間以上 初心者へのやさしさ 1/100
fsharp/fsharp.org#1019 ·
fsharp/fsharp.org の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
certification
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
bisq-network/support#2181 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
tutorial updates オープン
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
sveltejs/svelte.dev#2241 ·