matrix-org / matrix-org/matrix-spec
Consider de-emphasising section numbers in the ToC
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
From https://github.com/matrix-org/matrix-doc/pull/2959#issuecomment-762636762:
> Section numbers add a lot of visual clutter to the TOC sidebar ("12.14.1.3.2 Conditions"; the section number is longer than the section title). I would recommend to de-emphasize the numbers somehow, for example by using a lighter text color for them, to make the TOC easier to scan.
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
Start with the table-of-contents sidebar and review the linked pull request discussion for the rationale behind the section-number concern. The work is done when long section numbers are visually de-emphasized and the ToC is easier to scan without removing the numbers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100