0x0 Documentation
This is the documentation home for the 0x0 repository. The docs are organized by
reader path so beginners can start quickly and systems programmers can still
find exact implementation and evidence references.
If two documents appear to disagree, prefer the document that names the current
source file, evidence gate, and release version. If the conflict remains, treat
it as Needs verification and update the docs with the behavior-changing
change.
Beginner Path
Start here when learning or evaluating the project:
1. Getting Started: setup, first program, first checks.
2. Concepts: source-owned compiler, seed, OISA, capabilities,
packages, runtime boundary, and evidence gates.
3. Examples: minimal, realistic, edge-case, and failure examples.
4. Troubleshooting: symptom-oriented fixes.
5. Language Guide: implemented syntax and source behavior.
The public Learn course also lives under site/learn-0x0/.
Intermediate Path
Use these when writing source, packages, tools, or editor integrations:
- Syntax
- Language Specification
- Packages
- Package System
- Core Library
- Standard Library
- Scripting And REPL
- Editor Support
- Diagnostics
Advanced Path
Use these when changing compiler, runtime, release, ABI, or production evidence:
- Architecture
- Compiler Guide
- Compiler Pipeline
- Bootstrap Model
- ABI Guide
- ABI Value Layouts
- Runtime Capabilities
- Runtime Production Capabilities
- Type And Effect System
- Release Guide
- Release Compatibility
- Versioning
- Maintainer Manual
Reference
- API Reference
- API Cross Reference
- API Reference Guide
- Feature Support Matrix
- Platform Support
- Contract Integrity
- Documentation Standard
- Documentation Impact Review
- Documentation Audit
Common Tasks
Run an example:
./bin/zero run examples/add.0x0
Check documentation:
make documentation-impact-check
make docs-check
Regenerate generated API docs after public doc annotation changes:
make docs-api
make docs-check
Run the normal maintainer check:
make doctor
Run the self-host preservation gate:
make selfhost-guard