leanprover / leanprover/reference-manual
Examples shouldn't be wide enough to scroll for most users
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
Right now, some example code has horizontal scrolling. This shouldn't be necessary for most people, so the examples should be reformatted.
Steps:
- Measure how many columns are visible based on conservative assumptions about desktop and mobile screen width
- Have example code warn when this many columns are exceeded
- Fix the warnings, then upgrade it to an error that requires an explicit override flag on the example box
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 locating the example rendering and example-box validation used by the reference manual, then review the linked Zulip discussion for the screen-width assumptions. Add a warning for examples exceeding the chosen column limit, fix the reported examples, and make the warning an error unless an explicit override is provided.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100