Better examples via tldr
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
We have been relying on tldr for good examples. A few examples are missing:
- basenc - https://uutils.github.io/coreutils/docs/utils/basenc.html - https://github.com/tldr-pages/tldr/pull/10164
- hashsum - https://uutils.github.io/coreutils/docs/utils/hashsum.html
- relpath - https://uutils.github.io/coreutils/docs/utils/relpath.html
- 'sha3-224sum' 'sha3-256sum' 'sha3-384sum' 'sha3-512sum' 'sha3sum' 'shake128sum' 'shake256sum'
- mkfifo - https://uutils.github.io/coreutils/docs/utils/mkfifo.html
- head - https://uutils.github.io/coreutils/docs/utils/head.html
- cksum - https://uutils.github.io/coreutils/docs/utils/cksum.html
Some potential improvements:
Maybe tldr won't accept our custom binaries. If this is the case, we should have special cases for these
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 reviewing the linked utility documentation pages and the completed tldr pull requests for basenc and tsort. Determine whether tldr accepts these custom binaries or whether uutils needs special cases; done means the listed utilities have usable examples or an agreed project-side fallback.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100