freeCodeCamp / freeCodeCamp/devdocs
Documentation sorting
- 主要语言
- Ruby
- 星标
- 39.5k
- 派生
- 2.6k
- 平均合并
- 4 天 32 分钟
- 30 天内合并 PR
- 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
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100