code-docslisted

# Code Docs Documentation generation and maintenance for code projects. ## When to Document **Always update docs when:** - Adding new features - Changing existing behavior - Updating configuration - Breaking changes **Docs should live:** - Near the code (docstrings, comments) - In the repo (README, docs folder) - Generated (API docs, type docs) --- ## Doc Types ### README Project overview, setup, usage. See references/readme-structure.md **Template:** ```markdown # Project Name Brief description (one line). ## Quick Start 3-5 commands to get running. ## Installation Detailed setup steps. ## Usage Code examples. ## API Link to full API docs. ## Contributing How to contribute. ## License ``` ### API Documentation See references/api-docs.md for: - TypeDoc (JavaScript/TypeScript) - Sphinx (Python) - godoc (Go) - JSDoc (JavaScript) ### Changelog See references/changelog.md for Keep a Changelog format. **Sections:** - Added - Changed - Deprecated - Removed - Fixed - Security ### Architecture Docs See references/architecture-docs.md for: - ADRs (Architecture Decision Records) - Diagrams - System overviews --- ## Generation Commands ### TypeScript/JavaScript ```bash # TypeDoc npx typedoc --out docs src/index.ts # JSDoc npx jsdoc src/ -d docs/ # API Extractor (monorepos) npx api-extractor run ``` ### Python ```bash # Sphinx sphinx-build -b html docs docs/_build # pdoc pdoc --output-dir docs src/ # mkdocs mkdocs serve ``` ### Go ```bash # godoc g