leanprover / leanprover/reference-manual
Mark Planned Content with a dagger already in the section title
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
While the manual is already in use, but incomplete, it is somewhat disappointing to hopefully click on a section title, like “Quotients”, to only then see “Planned Content”. We can maybe avoid this anti-dopamine kick for our users if all sections with Planned Content are marked as such in the TOC, for example by writing Quotiens†, in a clever pun for inaccessible names in Lean.
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
Search the manual source for the table of contents and sections labeled “Planned Content”; no source file is named in the issue. Mark each affected section title in the TOC with a dagger, then check that the rendered links and existing planned-content notices remain correct.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100