public-docs-maintenance

Update public documentation by aligning generated reference outputs with concise task- and decision-focused guides. This process automatically reflects material changes to public-docs/ and publicly visible contracts across shipped workflows.

The best way to update public documentation after modifying Compartment workflows is to leverage generated reference content where possible and pair it with curated operator decision guides. This balances automated reference inputs with manual curation for clear public guidance.

You should regenerate public reference documentation whenever you touch the public-docs/ directory or materially change shipped Compartment workflows. This prevents public documentation from lagging behind code changes and confusing users and operators.

Updating public docs does not require manually rewriting all task guides because the process leverages generated reference inputs where possible. It pairs these automated outputs with concise task- and decision-focused guides to ensure clear public guidance.

Public documentation often lags behind shipped workflow changes because code updates are not automatically reflected in the public-docs/ directory. Running a dedicated docs-maintenance process aligns generated reference outputs with the latest operator decisions.

A limitation of using generated reference for public docs maintenance is that it only covers part of the scope. You must still manually pair generated outputs with concise task- and decision-focused guides to address publicly visible contracts and operator decisions comprehensively.