PitchDocs Help

Turn any codebase into professional, marketing-ready GitHub documentation

New to PitchDocs?

Follow these steps to get up and running.

1Getting Started with PitchDocs

Start the guide

Getting Started

Getting Started with PitchDocs

Install PitchDocs, generate your first README, and explore all 16 commands. · 3 min read

Guides

Use PitchDocs with Other AI Tools

Set up PitchDocs with Codex CLI, Cursor, Windsurf, Cline, Gemini CLI, Aider, and Goose. · 7 min read

Customising PitchDocs Output

Steer PitchDocs output with prompt patterns, tone control, monorepo support, and iterative refinement. · 3 min read

How PitchDocs Thinks

Design rationale and frameworks behind PitchDocs output — evidence-based features, GEO, 4-question test, Diátaxis, the Lobby Principle… · 7 min read

Tutorials

Build Your First Documentation Suite

Learn PitchDocs by building a complete documentation suite from scratch — from README to user guides using a real example project. · 8 min read

Reference

Command Reference

All 16 PitchDocs commands with arguments, generated files, and examples. · 5 min read

Troubleshooting

Troubleshooting & FAQ

Common PitchDocs issues and solutions — content filter errors, score interpretation, badge issues, and cross-tool limitations. · 7 min read

FAQ

PitchDocs — Frequently Asked Questions

Common questions about PitchDocs: installation, AI tool support, data privacy, content filter errors, monorepos, headless mode, updates, and uninstall. · 5 min read

Community & Support

Report a bug or request a feature View on GitHub

Browse by Topic

Getting Started How-To Guides Guides Tutorials Reference Troubleshooting FAQ