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>

Universal orchestration engine for the FP documentation system. Pure dispatcher that routes all 23 commands through multi-agent delegation across 11 engines. Write operations use 5 agents minimum (orchestrator + researcher + planner + specialist + validator). Read-only operations use 4 agents. Pre-execution intelligence via researcher and planner agents precedes all specialist work. Handles finalization (changelog, index, git) directly. Never executes fp-docs operations directly (D-06). <example> User: /fp-docs:revise fix the posts helper documentation <commentary> Write operation -- orchestrator spawns researcher for code analysis, planner for strategy, then delegates to modify engine (stages 1-3), validate engine (stages 4-5), handles finalization (stages 6-8). </commentary> </example> <example> User: /fp-docs:audit --depth deep docs/06-helpers/ <commentary> Read-only operation -- orchestrator spawns researcher for pre-analysis, planner for minimal plan, then delegates to validate engine, returns report. </commentary> </example> <example> User: /fp-docs:auto-update --batch-mode team <commentary> Batch write operation with explicit team mode -- orchestrator confirms with user, creates Agent Team, delegates to modify teammates, validates, finalizes with single commit. </commentary> </example> <example> User: /fp-docs:citations generate docs/06-helpers/posts.md <commentary> Specialist write operation -- orchestrator delegates to citations engine (delegated mode), then validate engine, then handles finalization. </commentary> </example> <example> User: /fp-docs:remediate <commentary> Remediation operation -- orchestrator loads remediation plan, dispatches to specialist engines per plan, validates all changes, finalizes with single commit. </commentary> </example>

Operation strategy engine for the FP documentation system. Receives pre-operation research analysis and designs execution strategies, creating persistent plan files that the orchestrator follows. All operations produce plan files (D-07) for consistent architecture and full audit trail. Always invoked in delegated mode by the orchestrator. <example> User: /fp-docs:revise fix the posts helper documentation <commentary> After researcher produces analysis, orchestrator spawns planner. Planner reads analysis, determines this is a single-file write operation, creates 3-phase plan (modify engine for write + validate engine for review + orchestrator for finalize). </commentary> </example> <example> User: /fp-docs:audit docs/06-helpers/ <commentary> Read-only operation -- planner creates minimal 1-phase plan (validate engine in standalone mode). Plan file still created for audit trail per D-07. </commentary> </example> <example> User: /fp-docs:auto-update --batch-mode team <commentary> Batch write operation with explicit team mode -- planner creates multi-phase plan with batch partitioning per mod-orchestration thresholds. Plan includes teammate assignments and batch boundaries. </commentary> </example>

Pre-operation code analysis engine for the FP documentation system. Runs before specialist engines to read source code, map dependencies, identify changes, and produce a structured analysis document. Activates for ALL operations (write and read-only) to provide deep code understanding to downstream planning and execution agents. Always invoked in delegated mode by the orchestrator. <example> User: /fp-docs:revise fix the posts helper documentation <commentary> Orchestrator spawns researcher before specialist engines. Researcher reads helpers/posts.php, maps all function signatures, identifies recent git changes, maps dependencies to other helpers. Produces analysis file at .fp-docs/analyses/. </commentary> </example> <example> User: /fp-docs:audit docs/06-helpers/ <commentary> Read-only operation -- researcher still runs to pre-load code understanding. Produces summary-depth analysis (function count, change detection, key patterns) rather than full-depth analysis. </commentary> </example>

System maintenance engine for the FP docs plugin. Handles plugin self-maintenance operations including skill regeneration, plugin setup verification, and configuration management. <example> User: /fp-docs:update-skills <commentary> Regenerate plugin skill files from source definitions — routes to docs-system with operation "update-skills". </commentary> </example> <example> User: /fp-docs:setup <commentary> Initialize or verify plugin installation — routes to docs-system with operation "setup". </commentary> </example> <example> User: /fp-docs:sync <commentary> Branch sync request — detects codebase branch, creates/switches docs branch, generates diff report. </commentary> </example>

Documentation validation engine for the FP codebase. Performs read-only audits, verification checklists, sanity-checks, and live environment testing on developer documentation. Never modifies files — only reports discrepancies. <example> User: /fp-docs:audit --depth deep docs/06-helpers/ <commentary> Comprehensive accuracy audit of helper docs — routes to docs-validate with operation "audit". </commentary> </example> <example> User: /fp-docs:verify docs/02-post-types/ <commentary> Run the 10-point verification checklist — routes to docs-validate with operation "verify". </commentary> </example> <example> User: /fp-docs:sanity-check docs/06-helpers/posts.md <commentary> Zero-tolerance claim validation against source code — routes to docs-validate with operation "sanity-check". </commentary> </example> <example> User: /fp-docs:test rest-api <commentary> Test documentation claims against live local environment — routes to docs-validate with operation "test". </commentary> </example>

Verbosity audit engine for the FP codebase. Read-only scanner that detects banned summarization phrases, missing enumerable expansions, incomplete lists, and scope manifest violations in developer documentation. <example> User: /fp-docs:verbosity-audit docs/06-helpers/ <commentary> Scan helper docs for verbosity gaps and banned phrases — routes to docs-verbosity with scope "docs/06-helpers/". </commentary> </example> <example> User: /fp-docs:verbosity-audit --depth deep <commentary> Deep scan of all docs for banned phrases and missing items — routes to docs-verbosity with depth flag. </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.

Manage code citations in documentation files. Subcommands: generate (create new), update (refresh stale), verify (check format), audit (deep accuracy check).

Mark documentation as deprecated when code has been removed or replaced. Updates the doc with deprecation notice and updates trackers.

Route natural language to the right fp-docs command. Describe what you want to do and the system matches your intent to the best command.

Display all fp-docs commands grouped by type with descriptions. Quick reference for discovering available documentation operations.

Manage locals contract documentation for WordPress template components. Subcommands: annotate, contracts, cross-ref, validate, shapes, coverage.

Run documentation operations in parallel across multiple files using Agent Teams. Opt-in feature — falls back to sequential if teams are disabled.

Resolve audit findings by dispatching to the right specialist engines. Takes audit output or a saved plan and orchestrates batch remediation.

Fix specific documentation you know is wrong or outdated. Provide a description of what needs fixing and the engine will locate, update, and validate the affected docs.

Validate that documentation claims match actual source code. Zero-tolerance mode flags any discrepancy.

Initialize or verify the fp-docs plugin installation. Checks plugin structure, docs repo setup, codebase gitignore, and branch sync state.

Synchronize the docs repo branch with the codebase branch. Creates or switches docs branches, generates diff reports, and optionally merges docs branches.

Execute runtime validations against the local development environment. Tests REST endpoints, WP-CLI commands, template rendering, and visual verification via browser automation.

Regenerate the CLAUDE.md template with current skill inventory, documentation links, and project configuration.

Refresh the PROJECT-INDEX.md codebase reference. Scans source files and updates the master index.

Regenerate all plugin skills from the current prompt definitions. Syncs skill files with the source-of-truth prompts.

Check for and install fp-docs plugin updates. Shows changelog from GitHub release notes, confirms before updating.

Scan existing documentation for verbosity gaps — missing items, summarization language, unexpanded enumerables.

Run the 10-point verification checklist on documentation files without making changes. Reports pass/fail for each check.

15 hooks across 5 events