TinyCloud docs are organized around reader journeys and Diataxis roles. The
homepage is the intent selector, start/ contains the reader-path pages, and
the remaining sections split into build, understand, and operate.
Install the Mintlify CLI to preview the docs locally:
npm i -g mint
mint devOpen the docs root where docs.json lives and preview at
http://localhost:3000.
reference/protocol/capabilities.mdx is generated from the canonical
TinyCloudLabs/tinycloud-node capability registry. Refresh and verify it with:
npm run sync-capabilities
npm run check-capabilitiesSet TINYCLOUD_CAPABILITIES_PATH to a local capabilities.json when checking
local or unmerged registry changes without fetching from GitHub. The generated
page should remain hand-off only: do not edit it directly.
/- Reader-journey homepage/start/browser-app- Web SDK path from sign-in to first KV write/start/backend-service- Node SDK path and sign-in mode decision/start/protocol- Capability, manifest, and delegation vocabulary/start/operator- CLI, hosting, OpenKey, and troubleshooting path/guides/browser-e2e-testing- Automated OpenKey + TinyCloud E2E testing for agents and CI/guides/agent-skills- Install thetc-cliagent skill and app skill packs/guides/share-viewer- Share viewer content rules and Web SDK share receiving/cli/share- Publish, notify, inspect, receive, and revoke Share links/concepts/system-model- High-level model of identity, spaces, capabilities, and services/concepts/security-and-trust- Trust boundaries and what TinyCloud does or does not guarantee/reference/glossary- TinyCloud vocabulary/reference/protocol/capabilities- Generated capability registry for exact action names and status/openkey/index- OpenKey overview and integration path/openkey/local-development- Run OpenKey and Secret Manager locally for development
Changes are deployed to production automatically after pushing to the default branch via the Mintlify GitHub app.