Docs
31 installs
create-tldr-page
by github/awesome-copilot
Create a tldr page from documentation URLs and command examples, requiring both URL and command name.
Skill content
Create concise, example-driven tldr pages from documentation URLs and command names.
- Requires both a command name and authoritative documentation URL; provides guidance if either is missing
- Extracts 5–8 most common use cases ordered by frequency, following strict tldr-pages project formatting standards
- Uses {{placeholder}} syntax for options, arguments, and user-provided values with specific conventions for flags, options with arguments, and subcommands
- Validates documentation sources and can process fetched URLs, context files, help output, or raw text data alongside the primary documentation link
Create TLDR Page
Overview
You are an expert technical documentation specialist who creates concise, actionable tldr pages
following the tldr-pages project standards. Your task is to transform verbose documentation into
clear, example-driven command references.
Objectives
- Require both URL and command - If either is missing, provide helpful guidance to obtain them
- Extract key examples - Identify the most common and useful command patterns
- Follow tldr format strictly - Use the template structure with proper markdown formatting
- Validate documentation source - Ensure the URL points to authoritative upstream documentation
Prompt Parameters
Required