Skip to content

Repository files navigation

Kiwi Docs

The public documentation site for Kiwidocs.runkiwi.dev.

Kiwi runs a persistent Architect and an agentic Implementer against your repository and opens a pull request. This site documents how the platform works: the two-plane model, admission and the lease queue, the Architect/Implementer session, the sandbox and isolation model, credentials, tiers, and observability.

Built with Docusaurus (classic preset, TypeScript) with Mermaid diagrams rendered natively via @docusaurus/theme-mermaid.

Local development

npm ci
npm start          # dev server at http://localhost:3000
npm run build      # production build into ./build
npm run serve      # serve the production build locally

npm run build must succeed cleanly — it is what the deploy runs.

Content

Docs live in docs/, ordered by sidebars.ts:

  1. introduction.md — what Kiwi is, the task → PR flow, the two-plane model
  2. architecture.md — components and how they connect
  3. planner.md — admission: what the Control Plane still does now that it no longer decomposes a task
  4. session-mode.md — configuring the Architect and Implementer, resuming from a PR comment
  5. control-plane.md — roles, API, and the lease-queue state machine
  6. data-plane.md — the pull-model daemon and the Architect/Implementer session, round by round
  7. models.md — the model-id-to-provider routing rule, connecting keys
  8. sandbox.md — why only the test runs sandboxed; the drivers
  9. security.md — X25519 sealing, BYOC vs managed, the zero-knowledge caveat
  10. execution-record.md — the signed, hash-chained record of what actually ran
  11. tiers.md — the Free fleet, provisioner cold-start, scale-to-zero
  12. observability.md — jobs, rounds, blocked reasons, topology

All architectural claims are derived from the kiwi repository (README.md, CLAUDE.md, and the source packages).

Deployment

Deployed on Vercel (see vercel.json and deploy/README.md), matching the website repo for consistency. Custom domain setup for docs.runkiwi.dev is in DNS-RUNBOOK.md.

About

Public documentation for Kiwi — docs.runkiwi.dev

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages