Skip to content

README.md

Latest commit

 

History

History
105 lines (69 loc) · 5.26 KB

README.md

File metadata and controls

105 lines (69 loc) · 5.26 KB

PitchDocs Documentation

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:

Tutorial What You'll Learn
Build Your First Documentation Suite Walk 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:

Guide What You'll Do Time
Getting Started Install PitchDocs, generate your first README, explore all 16 commands 5 min
Workflow Recipes Copy-paste workflows: public-ready repos, releases, launches, docs maintenance varies
Customising Output Steer PitchDocs: prompt patterns, tone control, monorepo support, iteration 10 min
Troubleshooting & FAQ Fix content filter errors, interpret scores, resolve badge issues, cross-tool limitations 5 min
Other AI Tools Set up PitchDocs with Codex CLI, Cursor, Windsurf, Cline, Gemini CLI, Aider, Goose 10 min
Untether Integration Use PitchDocs with Untether remote control from Telegram 5 min

🔍 Reference (Information-Oriented)

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

Reference What It Contains
Command Reference All 16 commands with arguments, generated files, examples, cross-tool support

💭 Explanation (Understanding-Oriented)

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

Explanation What You'll Understand
How PitchDocs Thinks Evidence-based features, feature-to-benefit translation, GEO, 4-question test, Diataxis, Lobby Principle

🔗 Quick Links

Resource Purpose
README Project overview, features, badges, comparison table
Contributing How to improve templates, add skills, contribute code
Changelog Version history and what changed in each release
Support Getting help, contact, response times
AGENTS.md AI 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 scratch Build Your First Docs Suite
Generate a README for my project Getting Started → /pitchdocs:readme
See all 16 commands and what they do Command Reference
Understand how PitchDocs extracts features How PitchDocs Thinks
Fix a content filter error Troubleshooting
Set up PitchDocs with Cursor, Windsurf, or Cline Other AI Tools
Create a public-ready repo with all docs Workflows — "Make a Repo Public-Ready"
Steer PitchDocs output to match my tone Customising Output
⚡