Generate Docs

Step 3: Write Documentation

Structure Rules

Every doc should include:

1. Title — Clear H1 with the feature name
2. Overview — 2-3 sentences explaining what it does and why you'd use it
3. Configuration — YAML config examples with all options documented
4. Usage Examples — Real-world YAML workflow/route examples
5. API Reference — Config options table with types, defaults, and descriptions
6. Notes/Tips — Gotchas, best practices, common mistakes

Style Rules

• Use practical YAML examples — show real configs, not abstract schemas
• Include both minimal and full-featured examples
• Document expression support where applicable ({{ }} syntax)
• Cross-reference related docs with relative links
• Use tables for config option references
• Keep paragraphs short and scannable
• Use code blocks with yaml, typescript, or bash language tags

Config Option Tables

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `target` | string | required | State key to store result |
| `timeout` | number | `5000` | Timeout in milliseconds |

Step 4: Update Index

If creating a new doc, update docs/index.md to include it in the appropriate section.

Step 5: Verify

• All YAML examples are valid syntax
• All cross-references point to existing files
• Config options match the actual source code
• Expression examples use correct syntax (== not ===, and not &&)