tldr-pages/tldr

Poorly documented base pages for commands

Open

#18,255 opened on Sep 27, 2025

View on GitHub
 (13 comments) (4 reactions) (0 assignees)Shell (2,507 forks)batch import
help wanted

Repository metrics

Stars
 (30,937 stars)
PR merge metrics
 (Avg merge 7d 5h) (321 merged PRs in 30d)

Description

The base page for many of these commands does not instruct the user how to use the program. This should be fixed so that the program usage is clearer, similar to the git rework #17056

I added extra pages, but these need to be judged case-by-case basis.

Commands to rework:

  • amass
  • clangd
  • choco #18578
  • cradle #19329
  • crane #18301
  • dolt #19566
  • dotnet
  • dvc #19534
  • eselect
  • fossil #19599
  • gcrane #18300
  • hcloud
  • hg #18321
  • ibmcloud
  • kiterunner
  • koji
  • linode-cli
  • odps
  • openssl #19629
  • pio #19456
  • pueue #18262
  • puppet #18581
  • pyats #18555
  • reg
  • ruff
  • sfdk #19978
  • sui
  • toolbox #19408
  • vboxmanage #18256
  • vue
  • xml

Missing base pages

  • openstack
  • doctl

Contributor guide

Research direction
Examine the existing base pages for the listed commands, reference the git rework PR #17056 for format guidance, and apply the same structure to each incomplete command's base page.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitCommand line basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85