https://github.com/xtrape-com/xtrape-capsule-site
The official site and documentation for Xtrape Capsule.
https://github.com/xtrape-com/xtrape-capsule-site
agent ai-infrastructure capsule-service control-plane documentation opstage vitepress
Last synced: 29 days ago
JSON representation
The official site and documentation for Xtrape Capsule.
- Host: GitHub
- URL: https://github.com/xtrape-com/xtrape-capsule-site
- Owner: xtrape-com
- License: other
- Created: 2026-05-05T14:16:55.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-14T15:14:49.000Z (about 2 months ago)
- Last Synced: 2026-05-14T15:30:22.933Z (about 2 months ago)
- Topics: agent, ai-infrastructure, capsule-service, control-plane, documentation, opstage, vitepress
- Homepage: https://xtrape-com.github.io/xtrape-capsule-site/
- Size: 210 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Security: docs/security/agent-security.md
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# xtrape-capsule-site
[](./docs/legal.md)
[](https://xtrape-com.github.io/xtrape-capsule-site/roadmap)
[](https://xtrape-com.github.io/xtrape-capsule-site/)
[](https://vitepress.dev/)
Public website and documentation for **Xtrape Capsule** — a lightweight control
plane for AI-era Capsule Services.
Live site: https://xtrape-com.github.io/xtrape-capsule-site/
This is the public docs site. Source for the platform itself lives in:
- [`xtrape-capsule-ce`](https://github.com/xtrape-com/xtrape-capsule-ce) —
Opstage CE (backend, UI, deploy)
- [`xtrape-capsule-agent-node`](https://github.com/xtrape-com/xtrape-capsule-agent-node)
— Node embedded Agent SDK
- [`xtrape-capsule-contracts-node`](https://github.com/xtrape-com/xtrape-capsule-contracts-node)
— Shared Zod / TS contracts
## Stack
VitePress + TypeScript + Markdown.
## Local development
```bash
pnpm install
pnpm docs:dev # http://localhost:5173
```
## Build
```bash
pnpm docs:build # output: docs/.vitepress/dist
pnpm docs:preview # serve the built site locally
```
## Deploy
The site is deployed by the GitHub Actions workflow in
`.github/workflows/deploy.yml`. Pushing to `main` rebuilds and publishes to
GitHub Pages.
To deploy manually:
```bash
pnpm docs:build
# upload docs/.vitepress/dist to your hosting target
```
## Layout
```text
docs/
├── index.md # homepage (hero + module overview)
├── getting-started/ # quick start, install, first capsule service
├── concepts/ # capsule service / opstage / agent / registration / contract
├── opstage-ce/ # CE-specific deployment, configuration, admin UI, backup
├── agents/ # agent SDK pages
├── contracts/ # contract-level reference
├── use-cases/ # integration services / Playwright workers / account pool / AI agent runtime
├── editions/ # CE / EE / Cloud
├── security/ # token model, agent security, overview
├── roadmap.md
├── faq.md
└── glossary.md
blog/ # release posts
docs/public/ # static assets copied by VitePress
.github/workflows/deploy.yml # CI deploy to GitHub Pages
```
## Contributing docs
1. Fork or branch.
2. Edit Markdown under `docs/`.
3. Run `pnpm docs:dev` and check your changes.
4. Run `pnpm docs:build` before opening a PR.
5. Open a PR; CI will rebuild on merge.
Style guidance:
- Lean technical, not marketing.
- Concrete examples beat abstract definitions.
- Don't expose internal naming, business strategy, or non-public roadmaps.
## License and trademarks
Code snippets and technical documentation in this site are licensed under
**Apache-2.0**, the same license as the rest of the Xtrape Capsule repositories.
**Xtrape**, **Xtrape Capsule**, **Opstage**, and related logos or marks are
trademarks or planned trademarks of their respective owners. The open-source
license does **not** grant trademark rights — see
[docs/legal.md](./docs/legal.md) for the full statement.