Reference overview
The Reference section is exhaustive and authoritative. If behavior is documented here, it is what the tool does. If the tool does something else, that's a bug.
Most Reference pages are auto-generated from the source code and regenerated on every commit via cargo xtask docs. If you change a CLI flag, a config key, an event variant, an exit code, or an MCP tool, the corresponding page updates automatically.
Sections
- CLI — every
versionxsubcommand and flag. versionx.toml— every config key with type, default, and "since" version.versionx.lock— lockfile format and merge-conflict guidance.- State DB schema — tables and the "safe to delete" contract.
- Events & tracing — the event taxonomy plus OTLP setup.
- Exit codes — every exit code with semantics.
- Environment variables — everything Versionx reads from env.
Conventions
- Status in frontmatter:
Stable,Experimental, orPlanned. Default isStable. Planned items show a banner linking to the roadmap. - Since on every CLI flag, config key, event, and SDK item:
Since 0.5,Since 0.7, etc. - See also at the bottom of every page: 2–4 links to related material.
Auto-generation
Every generated page starts with:
<!-- GENERATED by `cargo xtask docs-<name>`. Do not edit. -->
If you want to change generated content, edit the source and re-run the generator. See Contributing → Release engineering for the regeneration pipeline.