Code Docs

What it does

Code Docs provides practical, repo-adjacent guidance and templates for generating and maintaining documentation across languages and project types. It consolidates best practices for README structure, API documentation (TypeDoc, Sphinx, godoc), changelog conventions (Keep a Changelog), and architecture docs so engineers can quickly produce consistent, testable documentation. The skill includes command examples for TypeScript, Python, and Go and prescribes a simple workflow: identify documentation needs, generate or update docs, verify examples and links, then commit with a clear message.

When to use it

Use this skill when adding new features, changing public APIs, preparing releases, or when a contributor asks "how do I document this?" Ideal for repository maintainers who want reproducible docs generation (TypeDoc, Sphinx, mkdocs) and a minimal README template for project onboarding.

What's included

• Scripts: Templates and generator command snippets (TypeDoc, JSDoc, Sphinx, pdoc, mkdocs, godoc).
• References: Linked guidance files under references/ for README structure, API docs, changelogs, and architecture docs.
• Instructions: Practical workflow steps: identify docs to update, run generators, verify examples and links, and commit using conventional docs commit messages.

Compatible agents

Best used by developer-focused agents with shell and file access that can run language toolchains (Node, Python, Go) or invoke repository build steps.