Contracts And Source Of Truth
Status: beta.
Regent docs should explain behavior without becoming the authority for behavior.
What Wins
Section titled “What Wins”- Product HTTP contracts define product service behavior.
- CLI contracts define shipped command behavior.
- Product records define workflow state.
- Chain records define money movement and wallet-approved state.
- Public docs explain the current system and link back to the owning surface.
If a page and a contract disagree, the contract wins and the page should be fixed.
Contract Files
Section titled “Contract Files”Platform serves:
/api-contract.openapiv3.yaml/cli-contract.yaml
Shared, Autolaunch, and Techtree command behavior lives in their owning contract files and in the Regents CLI contract inputs.
How To Write Public Command Examples
Section titled “How To Write Public Command Examples”Only use command examples that exist in the contract-backed command surface. For public Platform copy that names Regents CLI commands, run the public CLI copy check in the CLI repo.
cd /Users/sean/Documents/regent/regents-clipnpm check:platform-public-cli-copyHard Replacement Rule
Section titled “Hard Replacement Rule”When a public path or command shape changes, publish only the current path or shape. Do not add duplicate old routes, old command aliases, or pages whose job is to preserve old wording.