Add a table of contents page on every documentation.
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 活跃
调研方向
未指定任何文件、测试或入口点。首先阅读 README 中的愿景，并检查项目的语言和框架文档是如何组织的；当每份文档都有一份涵盖从入门材料到函数或类参考的已达成共识的目录时，工作就完成了。
由索引模型根据 Issue 内容生成。
描述
Feature request
I am suggesting a table of contents on each documentation.
Summary
The table of contents should start with entry into the language or framework, then functional or class reference of it.
This will make sure that everyone getting started on a language has a clear flow of knowledge from easy to expert, then for the experts, functional reference list will be a plus
Examples
lets say we want to create a table of contents for html:
Table of Contents: HTML
What is html ........................................................ 1
Evolution of HTML ............................................ 2
some feature ....................................................... n
Functional References
function one ......................................................... n +2
- 主要语言
- Ruby
- 星标
- 39.5k
- 派生
- 2.6k
- 平均合并
- 4 天 32 分钟
- 30 天内合并 PR
- 13
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
freeCodeCamp/devdocs 的其他 Issue
-
docs/improvement
难度 2/5 1-3 小时 新手友好度 62/100
freeCodeCamp/devdocs#1989 · 4 条评论 · 4 个 reaction ·
-
难度 5/5 一周以上 新手友好度 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
难度 5/5 一周以上 新手友好度 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
难度 4/5 3-5 天 新手友好度 45/100
freeCodeCamp/devdocs#2673 ·
-
feature
难度 5/5 一周以上 新手友好度 18/100
freeCodeCamp/devdocs#2669 · 3 条评论 · 3 个 reaction ·
查看 freeCodeCamp/devdocs 的全部 Issue
相似的 Issue
-
user-reported
难度 2/5 1-3 小时 新手友好度 85/100
Kong/developer.konghq.com#7316 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
TheOdinProject/curriculum#31408 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 74/100
bensheldon/good_job#1816 · 5 条评论 ·
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
notch8/utk_knapsack#148 ·