Tables of contents in RFCs
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 1.7k
- Avg merge
- 16h 14m
- Merged PRs (30d)
- 1
Description
I think having a table of contents embedded in RFCs (with links back to the top at each section) would really be useful. A table of contents can make a long page far less intimidating, and can possibly help readers find answers to the questions they may have.
As an example, Python PEPs do this.
One notable problem is that the markdown renderer generates section ids. This makes manually creating a ToC hard; furthermore, for more complicated header lines, I worry that the id tags generated by github and mdbook might even differ! Since I think most of us read RFCs on Github, I'm not sure how this could be solved without substantially changing the RFC workflow.
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the RFC workflow and how RFC Markdown is rendered on GitHub and in mdBook, with attention to generated section IDs. Define a solution that provides a linked table of contents and links back to the top without relying on incompatible manually written anchors; done means the approach is documented and demonstrated for long RFCs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100