Forge docs

forge-docs: Documentation

Purpose

Verify that user, contributor, architecture, operations, security, and release documentation is accurate and executable.

This is an agent playbook, not a claim of standalone analyzer coverage. Apply

fullstack-forge/references/shared/module-contract.md

for common applicability, evidence, command-safety, mutation, verification, and completion rules.

Never hide failed checks or claim that an operation ran when it did not.

Automatic activation signals

Activate when a request or direct repository evidence involves documentation, when the user explicitly names forge-docs, or when discovery proves an applicable boundary.

• Every maintained or distributed project

When not to activate

• No exemption; scope follows the artifact's audience

Automated support

Relevant discovery inputs are:

• documentation tree
• CLI help
• configuration and workflows

Available deterministic support, where present:

• Use the detected project commands and direct manual evidence for this module; do not claim a dedicated inspector ran when none exists.

Agent inspection procedure

1. Execute the README setup path in a clean environment and record where it breaks or diverges from reality.
2. Verify every documented command, environment variable, and configuration key against the current code.
3. Check operational documentation: deployment, migration, backup restoration, and incident procedures for executability.
4. Trace critical business rules and the permission model to written documentation, and record decisions that exist only in code or chat.
5. Sweep for broken links, stale screenshots, and outdated version references.

Manual inspection requirements:

• Review information hierarchy for each audience
• Check that limitations and human-only steps are conspicuous

Stack-specific guidance:

• Generate reference material from the same command and schema sources when practical

Evidence to collect

For formal findings, also follow fullstack-forge/references/PROTOCOL.md. Record the module's inspected boundary, relevant tests, direct observations, and unavailable evidence.

Primary standards used as criteria, not proof of compliance:

• Diátaxis concepts
• CommonMark
• WCAG 2.2

Common production failures

• Run installation, quick-start, command, configuration, troubleshooting, and contribution steps from a clean context
• Check architecture, data, security, deployment, recovery, compatibility, ownership, and release notes against current code
• Validate links, examples, diagrams, generated references, accessibility, and secret-free sample values

Missing-control checks

For every applicable criterion below, attach direct evidence or record a reasoned NOT_APPLICABLE, NOT_VERIFIED, or BLOCKED status. The list is a routing checklist, not evidence by itself.

• README accuracy
• Installation
• Local setup
• Environment variables
• Architecture
• API documentation
• Database diagrams
• Migration instructions
• Deployment instructions
• Troubleshooting
• Backup restoration
• Incident procedures
• Permission model
• Business-critical calculations
• Onboarding
• Outdated comments
• Broken links
• Decisions existing only in chat or undocumented knowledge

Commands and tools

• Run forge docs audit --json or fullstack-forge docs audit --json when an explicit audit is requested and the CLI is installed. Normal feature work does not require it.
• Use the deterministic support named above only for its documented bounded evidence.

Safe fixes

• Correct stale commands, links, examples, and diagrams
• Add missing evidence-backed operational notes

Approval-required changes

• Changing public commitments, support policy, or legal statements

Verification

• Follow the quick start in a clean directory
• Run link, example, and CLI-help consistency checks

Completion contract

Apply the shared module contract and the module-specific limitations below.

Known limitations

• Documentation cannot substitute for unimplemented behavior