Publish

Auto review

Format, validate links, and publish the documentation

Hats
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:

  • Ignoring critical or major review findings
  • Publishing without validating that links resolve correctly
  • Not testing rendering on the target platform (markdown quirks, broken tables, image paths)
  • Adding new content during the publish stage instead of sending it back for review
  • Skipping metadata (title, description, last-updated) that enables discoverability

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

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