leanprover / leanprover/fp-lean
Add backreferences to Unicode input instructions
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 192
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Description
Some readers are missing the instructions for typing things that aren't on their keyboards. There should be back-references to this from early code examples that contain non-ASCII characters.
See e.g. https://leanprover.zulipchat.com/#narrow/stream/270676-lean4/topic/Help.20with.20guillemet.20symbol
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 with the Unicode instructions at introduction.html#unicode, then inspect the early code examples for non-ASCII characters. Add back-references from those examples to the instructions, including the cases that prompted the Zulip discussion, and verify that the links are present and usable.
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
- 45/100