doc-generate

Documentation Generation

Generate or refresh all documentation for the target project or path.

Target: $ARGUMENTS (default: current directory).

Step 1: Detect project type

TARGET="${ARGUMENTS:-.}"
HAS_JAVA=false; HAS_NODE=false; HAS_PYTHON=false; HAS_FLUTTER=false

[ -f "$TARGET/pom.xml" ] && HAS_JAVA=true && echo "Java/Spring detected"
[ -f "$TARGET/package.json" ] && HAS_NODE=true && echo "NestJS/Angular detected"
[ -f "$TARGET/pyproject.toml" ] || [ -f "$TARGET/requirements.txt" ] && HAS_PYTHON=true && echo "Python detected"
[ -f "$TARGET/pubspec.yaml" ] && HAS_FLUTTER=true && echo "Flutter detected"

Step 2: API documentation

Load the openapi-spec-generation skill, then:

• Java/Spring Boot: Scan controllers for @RestController, @GetMapping, @PostMapping, etc. Extract route paths, request/response types, and generate or update docs/api/openapi.yaml.
• NestJS: Scan *.controller.ts for @Controller, @Get, @Post decorators. Extract DTOs and generate or update docs/api/openapi.yaml.
• Python FastAPI: Confirm /openapi.json is served at runtime (built-in). Export the spec with:

  curl -s http://localhost:8000/openapi.json > docs/api/openapi.json 2>/dev/null || echo "[NOTE] Start the service first to export live spec"
  

• Flutter: Skip API generation (client-side).

Step 3: Architecture diagram

Dispatch mermaid-expert agent to create a system diagram from the project structure:

• Scan top-level directories and entry points
• Identify key services, controllers, models, and external dependencies
• Produce a graph TB diagram showing components and data flows

Output to docs/diagrams/[detected-service-name]-architecture.md.

Step 4: README

Check if README.md exists:

ls $TARGET/README.md 2>/dev/null && echo "README exists" || echo "README missing"

• If missing: Generate from the stack-specific template in skills/documentation-generation/references/readme-templates.md.
• If exists: Check for stale sections:
  • Missing environment variables (grep process.env / os.environ / @Value against README)
  • Outdated build commands (compare against package.json scripts / pom.xml / pyproject.toml)
  • Report stale sections without overwriting (present diff to user for review)