Docs

Guides first, then the references.

Guides

Quickstart

Deploy an organization on a local devnet, give up the admin role, then run each proof stage and read what it prints.

Onboarding

Your own organization: design the signers, prefixes and quorums, deploy from bitcd.yaml, from code or by hand, check it, hand it to its quorums.

References

bitcd.yaml

The declaration: cast, connectors, intent types, fleets, locks, values, the bitcd CLI, and the lints that refuse an unsafe setup.

@bitcd/core

The library by subpath: protocol, client, SNIP-12 approvals, the reconcile engine, the fleet voter, the evidence log, the store, event folds, the ceremony, the org declaration.

The contract

Data model, actions and policy, IBitcd, events, revert reasons, deploy, reuse, extend.

Connectors

What an executor does with a committed document, and how to build a connector over your own system.

Extend

Build on it

Database grants, deploy gates, flags that fail closed, DNS under quorum, secrets rotation, runtime provenance, a treasury. The seams each one uses.

The code is the source of truth. When these pages and the repositories under github.com/bitcdorg disagree, the code wins and the site has a bug. Open an issue.