By tomkyser
Documentation management system for the Foreign Policy WordPress codebase. Three-repo architecture with branch mirroring, 9 engine agents, 19 user commands.
API Reference engine for the FP codebase. Generates and audits API Reference tables in developer documentation, ensuring every function, method, hook, and filter is documented with accurate signatures and provenance tracking. <example> User: /fp-docs:api-ref generate docs/06-helpers/ <commentary> Generate API Reference tables for helper docs — routes to docs-api-refs with subcommand "generate". </commentary> </example> <example> User: /fp-docs:api-ref audit <commentary> Audit all API Reference sections against source code — routes to docs-api-refs with subcommand "audit". </commentary> </example>
Citation management engine for the FP codebase. Generates, updates, verifies, and audits code citation blocks in developer documentation. Ensures every documentation claim is backed by traceable source code references. <example> User: /fp-docs:citations generate docs/06-helpers/ <commentary> Generate citation blocks for all helper docs — routes to docs-citations with subcommand "generate". </commentary> </example> <example> User: /fp-docs:citations update docs/08-hooks/ <commentary> Refresh stale citations in hook docs — routes to docs-citations with subcommand "update". </commentary> </example> <example> User: /fp-docs:citations verify <commentary> Check citation format and validity across all docs — routes to docs-citations with subcommand "verify". </commentary> </example> <example> User: /fp-docs:citations audit docs/05-components/ <commentary> Deep semantic accuracy check on component citations — routes to docs-citations with subcommand "audit". </commentary> </example>
Index management engine for the FP codebase. Maintains PROJECT-INDEX.md, cross-document links, and the CLAUDE.md template. Keeps documentation metadata in sync with the actual file system and Git state. <example> User: /fp-docs:update-index update <commentary> Incremental refresh of PROJECT-INDEX.md — routes to docs-index with operation "update-project-index". </commentary> </example> <example> User: /fp-docs:update-index full <commentary> Full regeneration of PROJECT-INDEX.md from scratch — routes to docs-index with operation "update-project-index" in full mode. </commentary> </example> <example> User: /fp-docs:update-claude <commentary> Regenerate the CLAUDE.md template from current plugin state — routes to docs-index with operation "update-example-claude". </commentary> </example>
Locals contract engine for the FP codebase. Manages $locals variable documentation across PHP template components — annotates source code with @locals PHPDoc blocks, generates contract tables in docs, validates contracts against code, and reports coverage metrics. <example> User: /fp-docs:locals annotate components/article/ <commentary> Add @locals PHPDoc blocks to article component templates — routes to docs-locals with subcommand "annotate". </commentary> </example> <example> User: /fp-docs:locals contracts docs/05-components/ <commentary> Generate contract tables for component docs — routes to docs-locals with subcommand "contracts". </commentary> </example> <example> User: /fp-docs:locals validate <commentary> Verify all documented contracts match actual PHP code — routes to docs-locals with subcommand "validate". </commentary> </example> <example> User: /fp-docs:locals coverage <commentary> Report documentation coverage for $locals across all components — routes to docs-locals with subcommand "coverage". </commentary> </example>
Documentation modification engine for the FP codebase. Handles revise, add, auto-update, auto-revise, and deprecate operations on developer documentation. Executes the full post-modification pipeline (verbosity, citations, API refs, sanity-check, verify, changelog, index) after each operation. <example> User: /fp-docs:revise fix the posts helper documentation <commentary> Targeted documentation fix — routes to docs-modify with operation "revise". </commentary> </example> <example> User: /fp-docs:auto-update <commentary> Git-diff-driven batch update — routes to docs-modify with operation "auto-update". </commentary> </example> <example> User: /fp-docs:add document the new meilisearch helper <commentary> Creating new documentation for new code — routes to docs-modify with operation "add". </commentary> </example> <example> User: /fp-docs:deprecate the AMP integration was removed <commentary> Marking documentation as deprecated — routes to docs-modify with operation "deprecate". </commentary> </example>
Create documentation for entirely new code that doesn't have docs yet. Describe the new code and the engine will analyze it and generate complete documentation.
Generate or update API Reference sections in documentation files. Extracts function signatures from source code and creates formatted reference tables.
Compare documentation against source code and report discrepancies. Supports quick, standard, and deep audit depths.
Batch-process all items listed in the needs-revision-tracker. Reads the tracker, processes each item, and marks them complete.
Auto-detect code changes since last documentation update and handle everything. Scans git diff, identifies affected docs, and updates them.
Uses power tools
Uses Bash, Write, or Edit tools
Own this plugin?
Verify ownership to unlock analytics, metadata editing, and a verified badge. GitHub access is read-only (username + org membership).
Sign in to claimOwn this plugin?
Verify ownership to unlock analytics, metadata editing, and a verified badge. GitHub access is read-only (username + org membership).
Sign in to claimBased on adoption, maintenance, documentation, and repository signals. Not a security audit or endorsement.
Documentation management system for the Foreign Policy WordPress codebase. fp-docs is a Claude Code plugin that automates the creation, revision, validation, and maintenance of technical documentation by reading your source code directly and keeping docs in sync with every change.
fp-docs enforces zero-tolerance verbosity (every source item must be documented), cross-references every claim against actual code, manages citations with provenance tracking, and maintains a separate docs git repo that branch-mirrors your codebase. It ships 19 commands, 9 specialized engines (including a universal orchestration engine that coordinates multi-agent execution), and an automated 8-stage post-modification pipeline that runs after every documentation change.
$locals arrays between files without formal contracts. fp-docs annotates source code with @locals PHPDoc blocks and generates contract tables./plugin marketplace add tomkyser/fp-docs
/plugin install fp-docs@fp-tools
claude --plugin-dir ~/cc-plugins/fp-docs/plugins/fp-docs
Important: Point --plugin-dir at plugins/fp-docs/, not the repo root. The repo root is the marketplace wrapper (fp-tools). The installable plugin lives at plugins/fp-docs/.
The plugin auto-allows Read, Grep, and Glob. Write, Edit, and Bash operations will prompt for user approval per-session. Validation commands run without permission prompts; modification commands will ask.
Install the plugin using one of the methods above.
Run setup to verify your environment:
/fp-docs:setup
Setup checks plugin structure, detects the docs repo, verifies the codebase .gitignore includes the docs directory, and confirms branch sync status. It reports overall health as HEALTHY, DEGRADED, or BROKEN.
Sync branches if prompted:
/fp-docs:sync
Try your first command -- run a quick audit to see the state of your docs:
/fp-docs:audit --depth quick
Update docs after code changes:
/fp-docs:auto-update
From here, the SessionStart hooks handle branch detection and plugin context injection automatically on every new session.
npx claudepluginhub tomkyser/fp-tools --plugin fp-docsDocumentation management system for the Foreign Policy WordPress codebase. Command-workflow-agent architecture with pipeline enforcement, 31 commands, 13 specialist agents.
Generate and maintain documentation from code with drift detection. Validates docs against source, auto-generates from code patterns, syncs outdated content, and provides reusable templates for consistent documentation.
Lightweight documentation memory for AI coding agents: scaffold a docs tree, validate it, and auto-load recent context each session.
Documentation and authoring workflow router: audit docs vs code drift, sync docs after changes, optimize prompts and SKILL.md files, validate GLFM and Markdown formatting, summarize files/URLs/images with fidelity enforcement. Use when: docs are out of date, CLAUDE.md needs improving, SKILL.md needs optimizing, checking if documentation matches code, summarizing files or URLs.
Read-only validator that generates comprehensive discrepancy reports comparing messaging consistency across ANY HTML-based website (WordPress, Hugo, Next.js, React, Vue, static HTML, etc.), GitHub repositories, and local documentation. Detects mixed messaging without making changes.
Agents specialized in technical documentation and knowledge management. Focuses on documentation architecture and user-focused writing.
Import external documentation locally - bypass AI-blocking sites via Context7, WebFetch, or Playwright