Documentation Generator

What it does

Generates scaffolded README.md and DESIGN.md files by analyzing a module's directory, code, and docstrings. The tool extracts names, descriptions, features, dependencies, usage examples and architecture notes, producing a starting point that developers can refine. It supports multiple languages (Python, Go, TypeScript, Rust) and outputs a checklist for post-generation verification.

When to use it

Use when creating a new module with missing documentation, when onboarding contributors who need quick module overviews, or as part of a CI step that detects absent docs. It is triggered on module creation or when missing docs are detected.

What's included

• Scripts: doc_generator.js script under the repo's scripts/ (has_scripts=true).
• References: none provided in this repo's skill (has_references=false).
• Instructions: run node scripts/doc_generator.js <module-path> with optional --force to overwrite or --json for machine output. The SKILL.md describes the generation flow and post-checklist (README: description, features, examples; DESIGN: goals, decisions, tradeoffs).

Compatible agents

Best suited for agent environments that can run Node.js scripts and inspect repository files (OpenClaw, Codex/CLI-style agents, Claude Code), and useful as a CI/automation utility for developer-focused assistants.