PitchDocs Documentation

May 6, 2026 · View on GitHub

Welcome to PitchDocs documentation. Learn PitchDocs through tutorials, guides, reference docs, and explanations. Pick your path:

📚 Learning Paths

🚀 New to PitchDocs? → Start here

  1. Build Your First Documentation Suite — Learn PitchDocs by building a complete docs suite from scratch (20 minutes)
  2. Getting Started Guide — Install PitchDocs, generate your first README, and explore all 16 commands (5 minutes)
  3. Workflow Recipes — Copy-paste-ready workflows for public-ready repos, releases, launches, and maintenance

💡 Want to understand PitchDocs better? → Read these

  • How PitchDocs Thinks — Design frameworks: evidence-based features, GEO, 4-question test, Diataxis, Lobby Principle
  • Customising Output — Steer PitchDocs: prompt patterns, tone control, monorepo support

🔧 Using a different AI tool? → See setup

🆘 Stuck? → Find answers

📖 Guides by Category

Documentation is organised into four types following the Diataxis framework:

🎓 Tutorials (Learning-Oriented)

Learn PitchDocs through a guided, hands-on journey:

TutorialWhat You'll Learn
Build Your First Documentation SuiteWalk through generating README, changelog, guides, and verification on a real project (20 min)

📋 How-To Guides (Task-Oriented)

Step-by-step instructions for common tasks — short, direct, action-focused:

GuideWhat You'll DoTime
Getting StartedInstall PitchDocs, generate your first README, explore all 16 commands5 min
Workflow RecipesCopy-paste workflows: public-ready repos, releases, launches, docs maintenancevaries
Customising OutputSteer PitchDocs: prompt patterns, tone control, monorepo support, iteration10 min
Troubleshooting & FAQFix content filter errors, interpret scores, resolve badge issues, cross-tool limitations5 min
Other AI ToolsSet up PitchDocs with Codex CLI, Cursor, Windsurf, Cline, Gemini CLI, Aider, Goose10 min
Untether IntegrationUse PitchDocs with Untether remote control from Telegram5 min

🔍 Reference (Information-Oriented)

Complete, accurate lookup docs — find what you need quickly:

ReferenceWhat It Contains
Command ReferenceAll 16 commands with arguments, generated files, examples, cross-tool support

💭 Explanation (Understanding-Oriented)

Deep dives into design philosophy, frameworks, and "why" — builds mental models:

ExplanationWhat You'll Understand
How PitchDocs ThinksEvidence-based features, feature-to-benefit translation, GEO, 4-question test, Diataxis, Lobby Principle
ResourcePurpose
READMEProject overview, features, badges, comparison table
ContributingHow to improve templates, add skills, contribute code
ChangelogVersion history and what changed in each release
SupportGetting help, contact, response times
AGENTS.mdAI context file with all skills, agents, commands, rules

⚙️ Skills Reference

PitchDocs includes 16 specialised skills loaded automatically when you use commands. Each skill has structured knowledge for a specific task:

See Available Skills in AGENTS.md for the complete inventory with descriptions and file paths.

📍 Find What You Need

I want to...Go here
Learn PitchDocs from scratchBuild Your First Docs Suite
Generate a README for my projectGetting Started → /pitchdocs:readme
See all 16 commands and what they doCommand Reference
Understand how PitchDocs extracts featuresHow PitchDocs Thinks
Get a quick answer to a common questionFAQ
Fix a content filter errorTroubleshooting
Set up PitchDocs with Cursor, Windsurf, or ClineOther AI Tools
Create a public-ready repo with all docsWorkflows — "Make a Repo Public-Ready"
Steer PitchDocs output to match my toneCustomising Output