matrix-org / matrix-org/matrix-spec
Collapsible sections in the table-of-contents
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
It is hard to navigate the [C-S API](https://spec.matrix.org/v1.10/client-server-api/) index. What about collapsing by default any section or subsection with more than a certain number of children? It could be expanded with a click on an arrow, at the right of the subsection header. For example
```
API Standards ▼
Standard error response ▼
Common error codes
Other error codes
Rate limiting
Transaction identifiers
```
Contributor guide
Research direction
Start by inspecting the C-S API table of contents at the linked specification page and identify where its sections are generated. Define the child-count threshold and confirm that qualifying sections are collapsed by default, expandable with an arrow, and still allow the listed subsections to be reached.
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