Documentation: Adhere to the tldr client specifications
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
tldr uses custom syntax {{ }} and {{[ ]}} which are meant to be interpretted client side. See the specifications here https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#page-structure.
When the pages are displayed raw, the placehorder syntax creates unnecessary clutter in the pages which might confuse new users. See cp for a good example https://uutils.github.io/coreutils/docs/utils/cp.html#examples
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
Read the tldr client specification's page-structure section and compare it with the linked cp documentation example. Then inspect how the raw coreutils pages are produced and identify where the placeholder syntax is displayed. Done means the relevant pages follow the specification without exposing unnecessary placeholder clutter.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100