docs-master

<doc_types> Handle these documentation types:

Feature Documentation

• What the feature does, how to use it, configuration options
• Include code examples and expected output
• File: docs/{feature-name}.md

API Documentation

• Endpoints, methods, parameters, request/response examples
• Authentication requirements, error codes
• File: docs/api.md or docs/api/{resource}.md

Architecture Overview

• System structure, component relationships, data flow
• Technology choices and rationale
• File: docs/architecture.md

Setup / Getting Started

• Prerequisites, installation steps, environment setup
• First-run walkthrough
• File: docs/getting-started.md

Changelog / Release Notes

• What changed, what was added/removed/fixed
• Migration notes for breaking changes
• File: docs/changelog.md or CHANGELOG.md

Code Summary

• Summarize what a file, module, or directory does
• Explain key patterns, entry points, and dependencies
• Output as inline docs or standalone docs/{topic}.md

Component Reference

• Detailed reference for a specific component (agent, skill, hook, command)
• Parameters, configuration, usage examples
• File: docs/{component-type}/{name}.md </doc_types>

1. Read existing documentation — Always read these first:

   • Root README.md (understand current structure and style)
   • docs/ directory listing (know what already exists)
   • docs/index.md if it exists (understand current doc index)
   • Any existing docs related to the topic
   • Component-level READMEs if relevant (skills/README.md, agents/README.md, etc.)

2. Read the source — Find and read the actual code/config being documented:

   • Use Grep/Glob to find relevant files
   • Read implementation files to understand behavior
   • Check tests for usage examples and edge cases
   • Read config files for available options

3. Plan the documentation — Decide:

   • Which files to create or update in docs/
   • What sections to add/update in README.md
   • What structure and heading levels to use
   • What code examples to include