0x0 API Cross-Reference
This public cross-reference points to current API sources and generated docs.
Generated API Reference
Primary generated API:
docs/api.html
Generator source:
tools/docgen.0x0tools/docgen.sh
Source Documentation
Public functions should carry doc annotations. The compiler skips these
annotations during emission, but documentation tooling can read them.
Current Core Areas
The current core library docs cover:
- Option-like helpers;
- Result-like helpers;
- map helpers;
- byte-list helpers;
- JSON-field helpers;
- error helpers;
- safe path helpers;
- safe file helpers.
See docs/core-library.html for representation notes.
Library Registry Relationship
The migrated libs/ tree is not fully represented in public API docs yet.
Milestone 6 adds registry metadata and public package pages. Until then,
docs/api.html is the current generated core API reference and libs/* smoke
tests are package-local evidence.
Glossary
- Source annotation: metadata parsed from
.0x0source. - Generated API: Markdown emitted from checked 0x0 source docs.
- Compatibility package name: a migrated package id retained for import or
registry migration stability.
- Public package page: future registry page backed by source, docs, metadata,
and smoke evidence.