fp-docs

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.

7 hooks across 4 events