Versioning and publishing
Source of truth
Section titled “Source of truth”- API behavior and DTO validation live in
TrustedStake/trusted-stake-api. - Partner-facing guides and the reviewed partner OpenAPI snapshot live in this repository.
- Any API change that affects partners must update both in the same release sequence.
Contract releases
Section titled “Contract releases”This site uses date-versioned documentation releases. Breaking changes require a new major contract version; additions remain backward compatible unless a deprecation notice says otherwise.
Hosting
Section titled “Hosting”The reviewed public Astro build is published at docs.trustedstake.ai. A separate build containing distribution guides and partner API operations is published behind access control at distro.trustedstake.ai. Hosting configuration and documentation content are versioned together in this repository.
OpenAPI review
Section titled “OpenAPI review”src/openapi/partner.yaml is committed and reviewed. Scalar reads that immutable snapshot. Production Swagger remains disabled by default and is not the documentation origin.
Maintained partner flows
Section titled “Maintained partner flows”Distribution docs import their scoped join contract from an exact API source commit and record its artifact hash. The machine-readable provenance distinguishes a reviewed source contract from a qualified API/frontend release. Publishing a guide does not activate API capabilities; the features and scopes enabled for your partner determine availability.
The human guides and machine-readable Markdown use the same public/private content boundary. CI builds and inspects both variants, validates OpenAPI and examples, and detects imported-contract drift. Qualifying an API release separately requires confirming the matching API/frontend behavior in the target environment.