rust-lang / rust-lang/reference
Idea: Add a "General" section for each of the chapters that has both top-level contents and sections.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
Currently some chapters having sub-sections are totally blank in the top-level, while some chapters has contents within the chapter-link. Personally i think this is both inconsistent and ugly. I'd suggest we move to a model closer to ISO standards and many other specifications - Move the top-level contents to a first subsection consistently called "General". (Not sure whether this is well-supported by mdbook or not).
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 by reviewing the Reference's chapter organization and checking whether mdBook supports moving top-level contents into a consistently named first subsection. Compare chapters with and without subsections, then determine the complete set of navigation and content changes needed for a consistent “General” section across the affected chapters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100