AI Documentation Generation

AI documentation generation with Stoneforge lets you produce and maintain automated code documentation that reflects the current state of your codebase. You describe what you need, and the Director breaks it into tasks that workers handle in parallel.

Generate docs per module

Each worker agent focuses on a specific module or package, reading the source code and generating documentation from it. This approach to AI documentation generation ensures thorough coverage without overwhelming a single agent.

# Create a documentation plan
sf plan create --title "Generate API documentation" \
  --description "Generate API docs for all public endpoints. Include request/response examples, error codes, and authentication requirements. Output as MDX files in docs/api/."

# The Director creates tasks per module:
# 1. Document /api/auth endpoints
# 2. Document /api/users endpoints
# 3. Document /api/billing endpoints
# 4. Document /api/webhooks endpoints
# 5. Generate OpenAPI spec from route definitions

Context-aware automated code documentation

Agents read your source code, trace how functions are called, and examine tests to understand expected behavior. This means generated docs can explain intent and usage patterns, not just function signatures. The quality depends on how readable your code is and how well you describe what you want in the task.

# Customize documentation standards in workspace prompts
# .stoneforge/prompts/worker.md:
# "Write docs in active voice. Include a code example for every
#  public function. Document error cases, not just happy paths.
#  Use the existing docs/ structure and link between related pages."

Keep docs updated when code changes

Documentation rot is the harder problem. When your code changes, create a task to update the affected docs. Stoneforge’s automated code documentation agents diff the codebase against existing docs and update only what’s changed.

# Create a task to update docs after code changes
sf task create --title "Update API docs for v2.3 changes" \
  --description "Review all code changes since v2.2 tag. Update affected API docs, add docs for new endpoints, deprecate removed ones."

Multiple formats from the same source

Need Markdown for your docs site and JSDoc for IDE tooltips? Create separate tasks for each format. They run in parallel, reading the same code but producing different output. Pair AI documentation generation with AI test generation to ensure your docs and tests stay aligned.

Capture institutional knowledge

Beyond API docs, Stoneforge agents can generate architecture decision records, onboarding guides, and runbooks. The kind of knowledge that usually lives in senior developers’ heads can be written down and kept in version control alongside the code.