Auto-generate documentation from code: README files, JSDoc comments, API docs. Scans project structure, detects frameworks, and produces ready-to-use documentation.
Auto-generate documentation from code: README files, JSDoc comments, API docs. Scans project structure, detects frameworks, and produces ready-to-use documentation.
Auto-generate README.md by scanning project files.
# Generate README for current directory
bash scripts/generate-readme.sh --dir .
# Specify output file
bash scripts/generate-readme.sh --dir /path/to/project --output README.md
Detects: package.json, pyproject.toml, Makefile, Dockerfile, framework (React, Express, FastAPI, etc.)
Generates sections: Title, description, installation, usage, available scripts, project structure, dependencies, license.
Generate JSDoc comments for undocumented JavaScript/TypeScript functions.
# Generate documented version
python3 scripts/jsdoc-gen.py --file src/utils.js --output src/utils.documented.js
# In-place modification
python3 scripts/jsdoc-gen.py --file src/utils.js --inplace
# Process all JS files in a directory
find src -name "*.js" -exec python3 scripts/jsdoc-gen.py --file {} --inplace \;
Analyzes: Parameter names, default values, TypeScript types, return statements, throw statements.
Generate API documentation from Express/Fastify route files.
# Scan routes directory
bash scripts/api-doc-gen.sh --routes-dir src/routes/ --output API.md
# Single file
bash scripts/api-doc-gen.sh --routes-dir src/routes/users.js --output API.md
Extracts: HTTP method, path, middleware (auth, validation), handler name. Outputs Markdown with endpoint tables.
references/doc-templates.md — README templates, JSDoc patterns, Python docstring formatsreferences/doc-best-practices.md — What to document, keeping docs maintainable