doc-workflow-rules

What problem does it solve?

Documentation workflow rules for UMRS ensure consistent processes for editing, Antora module structure, and publishing to prevent drift and unsafe updates.

Core Features & Use Cases

• Build Verification Rule: ensure docs build cleanly with Antora after edits.
• Archive-First Rule: never delete documentation; archive to docs/_scratch/ instead.
• Inbox Routing Rule: route doc content to agent inbox under .claude for processing and eventual archiving.
• Antora Structure Rule: enforce docs/modules/nav.adoc structure and module layout for publishable pages.
• Scratch Directory Rule: use docs/_scratch/ for content that needs staging or retirement from build.
• Xref Safety Rule: verify cross-references across all AsciiDoc pages to prevent broken links.
• AsciiDoc Conversion Rule: apply conversion and formatting standards during content processing.
• File Format Rule: ensure publishable content is .adoc or compatible.

Quick Start

Follow these rules whenever you edit docs/, write .adoc content, or manage Antora modules to maintain a compliant, archive-safe documentation workflow.