Veetbot / Engineering documentation
Governed by design. Inspectable by default.
A governed agent platform, designed in the open.
The canonical plan, runtime contracts, architecture decisions, and delivery evidence for Veetbot's modular general-purpose agent platform.
This repository is building the platform defined by the
engineering plan. The production delivery path
publishes this complete site at
docs.veetbot.com from the same tested revision as
the Veetbot API.
Authoritative sources¶
Markdown and YAML are canonical. HTML under site/ and dist/ is generated
and must never be edited by hand.
- Engineering plan — the canonical, normative plan.
- Milestones — every milestone grouped by state, with open work itemized; reconciled against the project state on every build.
- Current milestone — the work currently authorized.
- Project state — machine-readable execution state.
- Architecture decisions — approved ADRs.
- Changelog — notable product and documentation changes, newest first.
Archive provenance: the plan was converted from an archived Word document at
archive/Modular_General_Purpose_AI_Agent_Engineering_Plan.docx, retained only
as an archival record.
Guides¶
- Apple client — the Mac, iPhone, and iPad app: chat, attachments, Website Access, Memory and People, Email mode, and settings.
- Downloadable client — the terminal client's build, connection, and security guidance.
- Production deployment — host preparation, release, feature flags and owner scopes, verification, and rollback.
- Gmail integration runbook — connecting Gmail, Email mode, and unsubscribe assistance.
- People memory operations — imports, directory repair, duplicates, erasure, and rollback.
- Telegram surface runbook, WhatsApp integration runbook, and Bland calling setup — the optional messaging and calling channels.
Current status¶
The milestones page is the grouped summary of every milestone and the work still open; it is reconciled against the authoritative project state on every documentation build, so what it says is what the state file says. The current milestone page points into the plan for the work currently authorized, and recorded evidence lives with the project state.
For coding agents¶
Start with AGENTS.md in the repository root — it is the operating contract.
Then read, in order: the project state, the current-milestone page, and the
relevant sections of the engineering plan.
For humans¶
Use the navigation and search here to read the plan. A single self-contained HTML
version of the full documentation is produced by make docs and written to
dist/engineering-documentation.html; it opens locally without any other file.
How the documentation is organized¶
docs/plan/— the canonical engineering plan, its detailed designs, and the current-milestone pointer.docs/*.md— the user and operator guides listed above.docs/architecture.md— the implemented module boundaries and their canonical sources.docs/events.md— the implementation status of the event surface.docs/status/— machine-readable project state.docs/adr/— architecture decision records.archive/— the original Word document (archival only).site/,dist/— generated outputs; do not edit.