User guides, architecture references and cross-repository contracts for Respire.
| Guide | Topic |
|---|---|
| Overview | Components and data flow |
| Getting started | Setup and first memory |
| Architecture | Storage, keys and execution |
| Development | Build prerequisites and checks |
| Contracts | ABI, HTTP, CLI and sidecar compatibility |
npm ci
node contracts/validate.mjs
npm run dev
npm run buildThe development server listens on http://127.0.0.1:4173.
English is the default at /; Simplified Chinese is available at /zh/. The
language menu switches to the same document and section, including nested pages.
Browser language preferences do not redirect readers. Keep every public Markdown
page paired with the same relative path under docs/zh/, retain the English
heading IDs in translated headings, and preserve commands and API identifiers.
Local search indexes each language separately; Chinese queries use word
segmentation. npm run build checks page coverage, executable examples, technical
identifiers, heading anchors, language metadata and internal links/resources.
Pushing main builds a development documentation artifact in Actions. A stable vX.Y.Z tag publishes the built documentation and checksums in this repository's Releases. This workflow does not enable Pages or deploy production.
The respire-docs Pages project uses its GitHub integration to publish main at
https://docs.rsrs.rs. Set the project root to this repository, the build command
to npm ci && node contracts/validate.mjs && npm run build, and the output directory
to docs/.vitepress/dist. .node-version pins Node.js 22, matching Docs CI, and
wrangler.toml keeps the publish directory in version control. Publish only this
generated directory, never the repository root.
The Cloudflare Workers and Pages GitHub App must have access to this repository.
If Pages shows a disconnected Git account warning, check that respire-docs is
included in the App's selected repositories. A successful manual build does not
verify automatic deployments; confirm that a Git push produces a new deployment
for the corresponding commit.
Pull requests receive Pages previews. After merging to main, check the production
deployment in Cloudflare. To roll back, select a previous successful production
deployment in Pages; revert the corresponding commit before the next automatic
deployment if the rollback should persist.
See CONTRIBUTING.md and LICENSE.
First-party material uses the Respire Noncommercial License 1.0. Personal noncommercial use and self-hosting are permitted. Commercial use, including internal business deployment, requires prior written authorization. See commercial licensing.