freeCodeCamp / freeCodeCamp/devdocs
Documentation sorting
- 主要言語
- Ruby
- スター
- 39.5k
- フォーク
- 2.6k
- 平均マージ
- 4日 32分
- マージ済み PR(30日)
- 13
説明
# Feature request
## Summary
The docs navigation has been arranged in alphabetical order.
Pro: skimming for the topic is easier.
Con: Doesn't provide the flow of the original documentation; some documentations are best read in order since some topic(s) link to another. An example is React documentation (if I am not wrong).
Solution 1:
In the docs navigation, I think the docs should be sorted alphabetically while their headings/topics/links should be sorted as-is in the original documentation for continuous flow.
Solution 2:
Please provide a sorting mechanism (switch) either as-is from the source doc for those who prefer continuous flow or alphabetically to those who prefer alphabetical order.
## Examples
I prefer
▷ ...
▷ ...
▷ CSS
▷ HTML
▷ JavaScript
▽ React
▷ Installation
▷ Main Concepts
▷ Advanced Guide
▷ API Reference
▷ Hooks
▷ Testing
▷ ...
▷ ...
▷ Sass
▷ SVG
▷ Typescript
▷ ...
▷ ...
to

N/B: This is my opinion
コントリビューションガイド
調査の方向性
まず、issue にリンクされているドキュメントナビゲーションの実装と README のビジョンを確認します。現在のアルファベット順と元のドキュメント順を比較し、意図する結果がソース順の維持なのか、ユーザーが制御できる切り替えなのか、それとも別の設計なのかを明確にします。完了条件には、合意された動作とそれを裏付けるテストを含める必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- css, html, javascript, react, sass, typescript
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100