0x0LearnReferenceLibrariesMigration0x0.jmp0x1b.com

Generated API Docs

Current implementation evidence: docs/api.html, tools/docgen.0x0, and

tools/docgen.sh.

Source-Level Docs

Public functions can carry doc annotations:


(doc "Return the sum of two integers.")

The compiler skips the annotation for emitted behavior. The documentation

generator reads it to produce API reference content.

Generated Reference

The generated API reference is:


docs/api.md

It is generated from checked 0x0 source and should stay in sync with public

library functions.

Safe Public Site Work

Static site work should not run broad generated API checks by default. When API

source changes, use the repository's documented API generation path, then run

the relevant safe public site checks.

Practical Rule

When adding a public library function:

1. add a useful doc annotation;

2. keep the function name consistent with style rules;

3. update or regenerate API docs as required by the repository workflow;

4. add examples or tests when the behavior is user-visible.