Docs should begin with TOC
Open
Nobody has claimed this yet.
- Dominant language
- Less
- Stars
- 680
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
It's quite annoying to be required to scroll through the whole document for finding information about a topic.
As a reference document, the LESS documentation (Language Features and Function Reference) should begin with a hyperlinked TOC containing all H1/H2/H3 headers.
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.
Research direction
Locate the LESS documentation sections named Language Features and Function Reference, then review their existing H1, H2, and H3 headings. Add a hyperlinked table of contents at the beginning of each reference document containing those headings; done means readers can use the links to reach every listed section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100