Skip to main content

PitchDocs

Documentation skills and templates for AI coding assistants.

Scans your codebase and generates professional docs — README, CHANGELOG, CONTRIBUTING, llms.txt, and 15+ more. Every document answers the four questions readers actually ask. Works with 9 AI tools.

Claude Code Plugin Releasedv2.0.0
Get Started View on GitHub

From code to professional docs

Slash commands that turn your codebase into docs people actually read

What PitchDocs includes

  • Evidence-based feature extraction

    Scans 10 signal categories and surfaces selling points with file-level evidence.

  • 4-question framework

    Every doc answers: does this solve my problem, can I use it, who made it, where do I learn more?

  • 20+ file documentation audit

    Catch missing docs, broken metadata, and invisible images before you ship.

  • 15 slash commands

    Generate any doc type in under a minute, from README to llms.txt.

  • Ready-to-use templates

    CONTRIBUTING, SECURITY, SUPPORT, issue/PR templates, release config, and community health files — one plugin handles all of them.

  • llms.txt generation

    AI-readable content indices so coding assistants and search engines surface your docs.

  • GEO-optimised for AI citation

    Structured output so ChatGPT, Perplexity, and Google AI Overviews cite your project with accurate descriptions and statistics.

  • GitHub, GitLab, and Bitbucket

    Auto-detects hosting platform and adapts badges, URLs, CI config, and Markdown rendering for each.

  • Progressive disclosure

    Non-technical language first, technical depth deeper, with automatic cross-linking.

  • Works with ContextDocs

    For AI context files (CLAUDE.md, AGENTS.md, .cursorrules, and more), install ContextDocs separately. Signal Gate filtering, Context Guard hooks, and health scoring — same marketplace, same install pattern.

  • Quality scoring

    Grades documentation 0–100 on completeness, structure, freshness, link health, evidence, and GEO readiness. Export to CI with --min-score.

  • Works with 9 AI tools

    Claude Code, OpenCode, Codex CLI, Cursor, Windsurf, Cline, Gemini CLI, Aider, and Goose — same skills and templates across all.

Get started in 60 seconds

Three steps for Claude Code, or one prompt for any other AI agent

Claude Code

Install via the LBA plugin marketplace. Full plugin access with slash commands, rules, and hooks.

1

Add the LBA plugin marketplace

/plugin marketplace add littlebearapps/lba-plugins

One-time setup — works in both Claude Code and OpenCode

2

Install PitchDocs

/plugin install pitchdocs@lba-plugins

Pure Markdown plugin, no build step

3

Try your first command

/pitchdocs:readme generate

Scans your codebase and generates a marketing-friendly README. See more commands below.

Other AI agents

Works with:

OpenCode Codex CLI Cursor Windsurf Cline Gemini CLI Aider Goose
Read the PitchDocs skills and templates in .claude/skills/ and generate documentation for this project. Start with a README.

Looking for AI context file management? See ContextDocs →

Claude Code

Try these commands

Claude Code slash commands — copy one to see it in action

"/pitchdocs:readme"

Scans your codebase and generates a marketing-quality README

"/pitchdocs:features"

Extracts features and benefits from 10 signal categories

"/pitchdocs:docs-audit"

Audits 20+ file types across 3 maturity tiers

Other AI agents

Try these prompts

Natural language equivalents — works with any AI agent that reads .claude/skills/

"Generate a README for this project"

Scans your codebase and generates a marketing-quality README

"Extract features and benefits from the codebase"

Analyses 10 signal categories for selling points

"Audit the project documentation"

Checks 20+ file types across 3 maturity tiers

"I kept writing the same boilerplate documentation for every new project — README, contributing guide, changelog, security policy. And the result was always mediocre."

Nathan
N
Nathan

Help & support

Getting Started

Set up PitchDocs step by step

All PitchDocs Help

Guides, reference, and more

Issues
Documentation
Discussions
View on GitHub

Questions about PitchDocs

What is PitchDocs?
PitchDocs is a documentation plugin that generates and audits public-facing repository documentation. It produces README files, changelogs, roadmaps, contributing guides, llms.txt files, and user guides designed to attract users and contributors. Works with Claude Code, OpenCode, Cursor, Codex CLI, Gemini CLI, Windsurf, Cline, Aider, and Goose. For AI context file management (CLAUDE.md, AGENTS.md, .cursorrules), see ContextDocs.
How is PitchDocs different from other documentation generators?
Most generators produce technically-accurate but dry output. PitchDocs applies the 4-question framework — every document answers: does this solve my problem, can I use it, who made it, where do I learn more? The result is docs that sell as well as they inform.
Does PitchDocs work with any programming language?
Yes. PitchDocs scans your codebase for 10 signal categories (CLI commands, public API, configuration, integrations, performance, security, TypeScript/DX, testing, middleware/plugins, and documentation) regardless of language.
Does PitchDocs need an internet connection?
No. It's a pure markdown plugin with no runtime code and no external API calls. Everything runs locally inside your AI coding assistant.
What is the 4-question framework?
Based on the Daytona/Banesullivan approach used by high-star repos like PostHog, Fiber, and LobeChat. Every document must answer four reader questions: Does this solve my problem? Can I use it? Who made it? Where do I learn more?
Can I use PitchDocs with other AI coding assistants?
Yes. PitchDocs works with Claude Code (primary), OpenCode, Cursor, Codex CLI, Gemini CLI, Windsurf, Cline, Aider, and Goose. Install via the LBA plugin marketplace — the skills and templates are compatible across tools.
What's included in a documentation audit?
PitchDocs audits 20+ file types across 3 tiers (Essential: README, LICENCE, .gitignore; Professional: CONTRIBUTING, CHANGELOG, SECURITY; Mature: governance docs, release config). It also checks GitHub repository metadata, package registry configuration (npm/PyPI), and visual assets.
Does PitchDocs overwrite my existing docs?
Generated files are written to your repo directory. Use git diff to review changes before committing. You can always git restore to undo.

Roadmap

Coming Soon

  • Exploring: Figma/design asset documentation support
  • Exploring: Multi-language README generation

Changelog

v2.0.0
github-actions[bot]github-actions[bot]
  • •/pitchdocs:ai-context and /pitchdocs:context-guard moved to ContextDocs (https://github.com/littlebearapps/contextdocs). Both remain as stub redirects. 39 files changed, 16 skills, 3 rules, 1 hook.
  • •add 3 test artifacts — hook unit tests, banned phrase checker, results doc (dc54272)
  • •add 6 CI checks — spell check, actionlint, frontmatter validation, llms.txt consistency, orphan detection, token budgets (e2eb70b)
  • •add CI integration — hook tests, banned phrases, activation eval workflow (45372e4)
See release details on GitHub
v1.19.3
github-actions[bot]github-actions[bot]
  • •integrate website notification into release-please workflow (fc7f699)
See release details on GitHub
View all releases on GitHub →

Also by Little Bear Apps

ContextDocs Released
3 slash commands that generate and maintain AI context files for 7 tools with Signal Gate filtering.
Untether Released
Run Claude Code, OpenCode, or Codex CLI from Telegram. Voice notes, multi-project routing, and persistent sessions.
Outlook Assistant Released
20 tools for email, calendar, contacts, and more — all through natural language.
Platform SDKs In Testing
Budget guardrails for Cloudflare Workers. Circuit breakers, spend limits, and anomaly detection.
Platform SDK Plugin In Testing
AI enforcement for Cloudflare Workers cost safety. Rules, hooks, and agents for Claude Code.
← Back to All Builds