tldr-pages/tldr

Create base pages for groups of commands

Open

#19730 opened on Dec 2, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Shell (30,937 stars) (2,507 forks)batch import
help wanted

Description

As is seen in #19721, there are many commands that separate subcommand functionality into diffeferent binaries. It might be worth it to create base pages that forward the user to the appropriate pages.

If you run find . -type f -printf "%f\n" | cut -d - -f 1 | cut -d . -f 1 | sort | uniq -c | sort -n in a platform directory, it is much easier to find these groups.

Also, let us limit the base pages to commands that contain the base text in themselves like transmission. I do not want to start documenting based on package names.

Please research if the pages are even related before making a base page

Groups

  • elasticsearch-
  • llvm-
  • virt- (might be two projects intertwined)
  • qemu-
  • gst-
  • redis-
  • systemd-
  • pw-
  • steamos-
  • grub-
  • xdg-
  • rpicam-
  • plasma-
  • gnome-
  • po4a-
  • cockpit-
  • avahi-
  • ubuntu-
  • nixos-
  • cpufreq-
  • spa-
  • gitlab-

Contributor guide

Tech stack
shell
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with tldr project structureBasic command line usageAbility to verify command relationships
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
First, understand the structure of existing base pages (e.g., see how `transmission` handles subcommands). Use the command `find . type f printf "%f\n" | cut d f 1 | cut d . f 1 | sort | uniq c | sort n` in a platform directory to identify groups. For each group listed, research the actual commands to ensure they are related before creating a base page. The issue provides a checklist; start with one group like `elasticsearch ` or `llvm ` and create a base page that forwards users to the appropriate subpages. Refer to the discussion in #19721 for context.