Add a table of contents page on every documentation.
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Active
- Domain
- documentation
Research direction
No files, tests, or entry points are named. Start by reading the README vision and reviewing how the project's language and framework documentation is structured; the work is done when every documentation has an agreed table of contents covering introductory material through functional or class references.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- Ruby
- Stars
- 39.5k
- Forks
- 2.6k
- Avg merge
- 4d 32m
- Merged PRs (30d)
- 13
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from freeCodeCamp/devdocs
-
docs/improvement
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
freeCodeCamp/devdocs#1989 · 4 comments · 4 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
Difficulty 5/5 Over a week Newbie friendliness 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
Difficulty 4/5 3-5 days Newbie friendliness 45/100
freeCodeCamp/devdocs#2673 ·
-
feature
Difficulty 5/5 Over a week Newbie friendliness 18/100
freeCodeCamp/devdocs#2669 · 3 comments · 3 reactions ·
All issues in freeCodeCamp/devdocs
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Homebrew/homebrew-cask#288729 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100