PitchDocs

Name: PitchDocs
Author: Little Bear Apps

Turn any codebase into professional, marketing-ready GitHub documentation

CC Plugin Released

Get Started View on GitHub

What PitchDocs does

A Claude Code plugin with 16 slash commands. Also works with Cursor, Windsurf, Codex CLI, and 5 more.

README.md

🐕 Untether

Telegram bridge for AI coding agents.
Send tasks by voice or text, stream progress live, and approve changes — from your phone.

CI passing PyPI v2.4.0 Python 3.10+ MIT

⚡ Quick start

      $ uv tool install untether
    

🎯 Features

📡 Progress streaming — watch your agent work in real time
🔐 Interactive permissions — approve with inline buttons
📁 Projects & worktrees — target repos, run branches in parallel
💰 Cost tracking — per-run and daily budgets

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.
16 slash commands
Generate any doc type in under a minute — README, changelog, llms.txt, and 13 more.
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.
CI-ready validation
6 automated GitHub Actions checks — spell check, frontmatter validation, llms.txt consistency, banned phrase detection, orphan file detection, and token budget enforcement.
Content filter protection
Handles Claude Code's API filter for CODE_OF_CONDUCT, LICENCE, and SECURITY so you never hit HTTP 400 errors. Claude Code only.
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

Requires a AI Coding Agents account

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

Add the LBA plugin marketplace

/plugin marketplace add littlebearapps/lba-plugins

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

Install PitchDocs

/plugin install pitchdocs@lba-plugins

Pure Markdown plugin, no build step

Try your first command

/pitchdocs:readme generate

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

Other AI agents

Copy this prompt and paste it into any AI assistant:

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

Help & support

v2.2.0

Getting Started

Set up PitchDocs step by step

All PitchDocs Help

Guides, reference, and more

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.2.0

1 month ago

github-actions[bot]

•full plugin review fixes — version sync, hook exit codes, stale references, eval coverage (48dc592)
•remove out-of-scope skill-authoring skill (44ab591), closes #40
•add trigger phrases to feature-benefits skill for better activation (12c4db2)
•correct Outlook Assistant logo URL extension (.svg → .png) (36e208f)

See release details on GitHub

v2.1.0

1 month ago

github-actions[bot]