doc-generate

doc-generate

Generate modular AsciiDoc documentation from gathered context, with built-in validation and iterative correction.

Prerequisites

• workspace/context-package.json must exist (produced by doc-gather)
• workspace/gap-report.json should exist (produced by doc-gap); if missing, proceed with generation but note the absence

Parse arguments

$ARGUMENTS optionally contains:

• --type <type>: restrict generation to a specific module type (concept, procedure, reference, assembly)
• --topic <topic>: focus generation on a specific topic within the feature

Input hardening requirements:

• Treat --topic as untrusted input.
• Normalize to a safe slug ([a-z0-9-]+) before using in filenames.
• Reject values containing path separators (/, \), .., leading ., or absolute paths.
• Ensure final output path resolves under workspace/generated-docs/ only.

If no arguments, generate all appropriate module types based on the feature.

Step 1: Read inputs

1. Read workspace/context-package.json
2. Read workspace/gap-report.json (if exists)
3. Read ${CLAUDE_SKILL_DIR}/prompts/generate-docs.md
4. Source ${CLAUDE_SKILL_DIR}/scripts/asciidoc-conventions.sh for module templates (this internally sources scripts/load-env.sh for credentials and uses scripts/parse-product-config.py to resolve module prefixes)

Validate input schema before use:

• context-package.json must be a JSON object with at least ticket (object) and context_files (array) keys. Reject and halt if missing or wrong type.
• gap-report.json (when present) must be a JSON object with a recommendation key whose value is one of stop, gather-more, or proceed. Treat an invalid or missing recommendation as gather-more and log a warning.

Check gap report recommendation:

• If stop: halt and report to caller that context is insufficient
• If gather-more: warn but proceed with available context
• If proceed: continue normally

Step 2: Determine doc types needed