Workflow Cookbook

Step-by-step recipes for common PitchDocs workflows: public-ready repos, releases, launches, and maintenance.

Summary: Step-by-step recipes for common PitchDocs workflows — making repos public-ready, preparing releases, launching on platforms, and keeping docs fresh.

Each recipe lists the commands in order with brief notes — see the Command Reference for full argument details.

Make a Repo Public-Ready

Generate the full documentation set for a project you’re about to open-source or publish.

Extract user benefits — understand why someone should care about your project:
```
/pitchdocs:features benefits
```
Choose “talk it out” for the most compelling results — the conversational path surfaces your real use cases and motivations.
Generate README — this uses the extracted benefits to establish the project’s voice:
```
/pitchdocs:readme
```
Audit for missing docs — check what else the repo needs:
```
/pitchdocs:docs-audit
```
Auto-generate everything missing — fill all gaps in one go:
```
/pitchdocs:docs-audit fix
```
Bootstrap AI context files — for AI context file management, install ContextDocs:
```
/plugin install contextdocs@lba-plugins
/contextdocs:ai-context init
```
Generate llms.txt — make the repo AI-discoverable:
```
/pitchdocs:llms-txt full
```
Verify everything — check links, freshness, and quality:
```
/pitchdocs:docs-verify
```
Review the quality score — aim for 80+ (Grade B or above):
```
/pitchdocs:docs-verify score
```

Tip: If your score is below 80, run /pitchdocs:docs-verify without arguments to see which dimensions need improvement, then address them individually.

Prepare a Release

Update documentation after cutting a new version.

Update the changelog for the new version:
```
/pitchdocs:changelog v1.5.0
```
Refresh all affected docs — analyses git changes since the last tag and updates what’s needed:
```
/pitchdocs:doc-refresh
```
Verify nothing is broken — check for stale content and broken links:
```
/pitchdocs:docs-verify
```
Update badges — if your version badge is hardcoded, update it in README. If it uses shields.io dynamic badges, it updates automatically.

Using release-please? Run /pitchdocs:doc-refresh before merging the release-please PR. Release-please owns version strings; /pitchdocs:doc-refresh owns prose, features, metrics, and guides.

Launch on a Platform

Generate launch content for Dev.to, Hacker News, Reddit, Twitter/X, or awesome lists.

Ensure README is polished — launch artifacts are derived from it:
```
/pitchdocs:readme
```

Generate all launch artifacts:

/pitchdocs:launch

Or target a specific platform:

/pitchdocs:launch devto    # Dev.to article
/pitchdocs:launch hn       # Hacker News "Show HN" post
/pitchdocs:launch reddit   # Reddit post templates
/pitchdocs:launch social   # Twitter/X thread + social preview guide
/pitchdocs:launch awesome  # Awesome list submission PR

Review before posting — all artifacts are written to docs/launch/ for human review. Check for:
- Accuracy of feature claims
- Tone appropriate to the platform (HN values technical depth; Reddit varies by subreddit)
- Links are correct and publicly accessible
- Social preview image is set (GitHub Settings → Social preview)
Post and engage — launch artifacts are starting points, not copy-paste-ready. Adapt to the platform’s culture and your audience.

Keep Docs Fresh Over Time

Prevent documentation drift with regular maintenance.

Recommended cadence

Trigger	Action
After every release	`/pitchdocs:doc-refresh` (or `/pitchdocs:doc-refresh v1.x.0`)
Monthly (active projects)	`/pitchdocs:docs-verify` to check for staleness
Quarterly	`/pitchdocs:features audit` to catch undocumented features
After major refactors	Install ContextDocs and run `/contextdocs:ai-context update` to patch drift
After extended Claude sessions	Install ContextDocs and run `/contextdocs:ai-context promote` to move MEMORY.md patterns to CLAUDE.md

Add docs verification to CI

Run /pitchdocs:docs-verify ci to get a CI-friendly output format. Add to GitHub Actions:

# .github/workflows/docs.yml
name: Docs Verification
on:
  pull_request:
    paths: ['**.md', 'docs/**', 'llms.txt']

jobs:
  verify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: DavidAnson/markdownlint-cli2-action@v18
      - uses: lycheeverse/lychee-action@v2
        with:
          args: --no-progress '**.md'

For PitchDocs-specific checks (quality score, feature coverage, llms.txt sync), run /pitchdocs:docs-verify ci --min-score 70 in a Claude Code session or CI agent.

Document a New Feature

After adding a feature to your codebase, update docs to reflect it.

Check what PitchDocs detects:
```
/pitchdocs:features audit
```
Update user benefits (if the feature changes the project’s value proposition):
```
/pitchdocs:features benefits
```
Choose auto-scan for a quick draft, or “talk it out” for authentic, experience-driven benefits.
Update README features section:
```
/pitchdocs:readme focus on features
```
Update affected guides (if any):
```
/pitchdocs:doc-refresh guides
```
Patch AI context files (if ContextDocs installed):
```
/contextdocs:ai-context update
```
Verify everything is consistent:
```
/pitchdocs:docs-verify
```

Looking for command details? See the Command Reference. Having trouble? See the Troubleshooting guide.