leanprover / leanprover/reference-manual
Styling: Markdown header levels
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
The HTML output for release notes (rendered from Markdown) don’t use h2, h3 etc, making it hard to understand the document structure (e.g. when the highlights end and the first section starts.)
https://lean-lang.org/doc/reference/latest/releases/v4.21.0/
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
Inspect the release notes at the linked v4.21.0 page and trace how their Markdown is rendered into HTML. Confirm the heading hierarchy in the generated output; done means section headings use appropriate h2, h3, and subsequent levels so the document structure is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100