Documentation
README
api-docs — document a public API surface from the code
Produce reference docs that match the code exactly, derived from the source, not from assumptions about what the API "probably" does.
Read the surface
Identify the public surface to document (a module, class, CLI command group, or set of endpoints). Then have the researcher read it carefully:
- Dispatch the researcher (
purpose: explore) to enumerate the public entry points and report each one's real signature, parameters, defaults, return shape, and raised errors — with file:line evidence. - Prefer what the code declares (signatures, type hints, docstrings, default
values) over prose descriptions. Public vs. private follows the project's
convention (e.g. a leading underscore, or an
__all__/ export list).
This is the opening of the README. Read the full README on GitHub.