pitchdocs AGENTS.md

Repository instructions for PitchDocs, a tool for creating public-facing project documentation such as READMEs, changelogs, and roadmaps. They also describe its documentation standards and workflow.

In plain words
What is it for?
Use them when generating or reviewing READMEs, changelogs, roadmaps, documentation audits, or other PitchDocs outputs. They also point to available skills and context-file guidance.
Why use it?
They give an agent consistent rules for tone, language, structure, commits, and documentation quality. This reduces inconsistent or incomplete project documents.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/littlebearapps/pitchdocs/agents-md
Clone the repo
git clone --depth 1 https://github.com/littlebearapps/pitchdocs

Made for: Codex, OpenCode.

Per session 2,373 This file is loaded in full into every session.
When invoked 2,373 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02373 $0.02373
Opus 5 $0.01187 $0.01187
Sonnet 5 $0.00475 $0.00475
Haiku 4.5 $0.00237 $0.00237

Measured 2d ago against content hash 8fe369c74395, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

pitchdocs AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 97 lines

How it starts

The opening of the file, as written. The whole thing — 97 lines — stays where its author put it; the contents beside it link to each section on GitHub.

PitchDocs

Generate high-quality public-facing repository documentation with a marketing edge. PitchDocs creates READMEs that sell, changelogs that communicate value, roadmaps from GitHub milestones, and audits your docs completeness — with GEO-optimised structure for AI citation and launch artifacts for promotion. For AI context file management, see ContextDocs.

Documentation Standards

Australian English (realise, colour). Conventional commits. Benefit-driven language: [Feature] so you can [outcome] — [evidence]. 4-question test (problem? use? who? learn more?). Progressive disclosure (non-technical first paragraph, technical details deeper).

Available Skills

Skills are loaded on-demand to provide deep reference knowledge. Each lives at .claude/skills/<name>/SKILL.md (or .agents/skills/<name>/SKILL.md if you've copied them for Codex CLI). There are 15 skills in total.

Skill What It Provides
public-readme README structure with the Daytona/Banesullivan marketing framework — hero template, value proposition, quickstart with Time to Hello World targets, features with evidence-based benefits. Companion SKILL-reference.md has logo guidelines, registry badges, use-case framing, and visual element guidance (loaded on demand)
feature-benefits 7-step codebase scanning workflow — extracts concrete features from code, translates to benefit-driven language across 5 categories (time saved, confidence gained, pain avoided, capability unlocked, cost reduced). Generates features and benefits sections, "Why [Project]?" content, and feature audit reports. Companion SKILL-signals.md has detailed signal category scan lists, JTBD mapping, persona inference, conversational path prompts, and per-ecosystem pattern libraries (loaded on demand)
changelog Keep a Changelog format with language rules that rewrite conventional commits into user-facing benefit language. Maps feat: to Added, fix: to Fixed, etc.
roadmap Roadmap structure from GitHub milestones with emoji status indicators, mission statement, and community involvement section
pitchdocs-suite Full 20+ file inventory (README, CONTRIBUTING, CHANGELOG, CODE_OF_CONDUCT, SECURITY, AI context files, issue templates, PR templates, and more), GitHub metadata guidance, visual assets, licence selection framework, and ready-to-use templates
llms-txt llmstxt.org specification reference for generating llms.txt and llms-full.txt — LLM-friendly content indices for AI coding assistants
package-registry npm and PyPI metadata field auditing, cross-renderer README compatibility (GitHub vs npm vs PyPI), trusted publishing guidance, and registry-specific badges
user-guides Task-oriented how-to documentation with Diataxis framework, guide frontmatter standard, title conventions, numbered steps, copy-paste-ready code, error recovery, and cross-linked hub pages. Companion file SKILL-templates.md provides tutorial, reference, and explanation templates.
docs-verify Documentation validation — broken links, stale content, llms.txt sync, heading hierarchy, badge URLs, lightweight AI context health check, and CI-friendly output
launch-artifacts Platform-specific launch content — Dev.to articles, HN posts, Reddit posts, Twitter threads, awesome list submissions
api-reference API reference generator guidance — TypeDoc, Sphinx, godoc, rustdoc configuration templates and comment conventions
doc-refresh Version-bump documentation orchestration — analyses git history, identifies affected docs, delegates AI context refresh to ContextDocs if installed
visual-standards Visual formatting — emoji heading prefixes, horizontal rules, TOC anchors, callouts. Companion SKILL-reference.md has screenshot dimensions, HTML patterns, captions, shadows, image optimisation (loaded on demand)
geo-optimisation GEO patterns for AI citation — citation capsules, crisp definitions, atomic sections, comparison tables, statistics, semantic scaffolding

Read the full file on GitHub · 97 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 97 lines · 2,373 tokens per session scan A 8fe369c74395

Subscribe to this mod's changes

pitchdocs AGENTS.md is an instructions file published in the GitHub repository littlebearapps/pitchdocs (7 stars, last pushed 3mo ago), licensed MIT. It adds 2,373 tokens to every session, about $0.0119 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories