Skip to content

Guides to documenting your code.

How to generate documentation from a GitHub repository, keep it current as the code changes, and publish it.

Generate documentation from a GitHub repository

How to generate documentation from a GitHub repository: what gets read, how pages are planned and written, and how to review and publish them.

Read more

How to keep documentation up to date as your code changes

Why docs drift from code, and how to update only the pages a commit affects without overwriting what your team edited by hand.

Read more

How to verify AI-written documentation

A practical checklist for trusting documentation an AI wrote from your code: what to check, what to cut, and which safeguards matter.

Read more

Document a TypeScript library that has no docs

Your TypeScript library has no documentation. What TypeDoc covers, what it leaves out, and how to get guides and a hosted site from the repository.

Read more

Free docs hosting for an open-source project

The ways to host documentation for free for an open-source project, what Read the Docs and static hosts leave to you, and where a generated, hosted site fits.

Read more