create-tldr-page
Create concise, example-driven tldr pages from documentation URLs
by githubFree
Description
create-tldr-page is an agent skill from the github/awesome-copilot collection that writes a tldr page, the concise, example-driven command reference in the style of the tldr-pages project. Instead of a long manual, a tldr page shows the handful of commands most people actually need, each with a short description and a usage example. The skill requires two inputs: the name of the command and an authoritative documentation URL. If either is missing it gives guidance on how to find them rather than guessing. It reads the documentation, extracts the five to eight most common use cases, orders them by how frequently people use them, and writes them in the strict formatting of the tldr-pages project. It checks that the source is the upstream documentation for the tool and not a third-party summary. The skill is useful for maintainers of internal command-line tools who want a quick reference for their team, and for contributors who want to add a page for a tool that lacks one. Because the examples are drawn from documentation, they should be run against the tool before the page is published, so no example is wrong. The skill is installed with the skills CLI from the github/awesome-copilot repository. Its skills.sh page showed about 8.8K installs, with Gen Agent Trust Hub and Socket passing and Snyk showing a warning at the time of the scan.…
Highlights
- Concise example-driven command reference
- Five to eight most common use cases
- Ordered by frequency of use
- Requires a command name and an authoritative URL
- Follows tldr-pages formatting
- Installs with the skills CLI
Ratings & Reviews
No ratings yet
Be the first to rate create-tldr-page.
People also visit
acquire-codebase-knowledge
The user explicitly asks to map, document, or onboard into an existing codebase
create-tldr-page FAQ
What does it produce?
A tldr page for a command, with its most common use cases and examples.
What inputs are required?
The command name and an authoritative documentation URL. The skill helps you find them if either is missing.
How many examples does it include?
Five to eight of the most common use cases, ordered by frequency.
Should I test the examples?
Yes. Run them against the tool before publishing so no example is wrong.
How do I install it?
Run npx skills add https://github.com/github/awesome-copilot --skill create-tldr-page.
What security audits does it have?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Warn. A Warn or Fail is worth reading before you install.
What are the best create-tldr-page alternatives?
Popular alternatives to create-tldr-page include context-driven-development, grounded-vault and hads. See all create-tldr-page alternatives