Publish

Auto review

Format, validate links, and publish the documentation

Hats
1
Review Agents
1 +1
Review
Auto
Unit Types
Delivery
Inputs
Draft, Review

Dependencies

Draftdraft-documentation
Reviewreview-report

Hat Sequence

1

Publisher

Focus: Incorporate review findings, finalize formatting for the target platform, validate all links, and ensure metadata is complete. The publisher bridges "reviewed draft" to "live documentation" — addressing findings, confirming rendering, and verifying that the documentation is discoverable.

Produces: Final documentation ready for publication with all links validated, formatting verified, and metadata populated.

Reads: Draft documentation and review report via the unit's ## References section.

Anti-patterns (RFC 2119):

  • The agent MUST NOT ignore critical or major review findings
  • The agent MUST NOT publish without validating that links resolve correctly
  • The agent MUST test rendering on the target platform (markdown quirks, broken tables, image paths)
  • The agent MUST NOT add new content during the publish stage instead of sending it back for review
  • The agent MUST NOT skip metadata (title, description, last-updated) that enables discoverability

Review Agents

Formatting

Mandate: The agent MUST verify the published documentation renders correctly and is navigable.

Check:

  • The agent MUST verify that all links resolve (no 404s, no broken anchors)
  • The agent MUST verify that images and diagrams render at appropriate sizes
  • The agent MUST verify that code blocks have correct syntax highlighting
  • The agent MUST verify that table of contents and navigation reflect the actual content structure

Included from other stages

Accuracyfrom Draft

Publish

Criteria Guidance

Good criteria examples:

  • "All internal and external links resolve to valid targets"
  • "All critical and major review findings are addressed in the final version"
  • "Documentation renders correctly in the target platform (site, wiki, PDF)"

Bad criteria examples:

  • "Documentation is published"
  • "Links work"
  • "Formatting is done"

Completion Signal (RFC 2119)

Final documentation MUST exist with all review findings addressed. Links MUST be validated. Formatting is correct for the target platform. Metadata (title, description, last-updated date) is populated. Documentation is published or staged for publication.