Official Docs Crosswalk
Map the official eve.dev documentation corpus to this handbook and record the corrections made from the official docs.
Key takeaways
- This appendix maps all 67
/docs/*Markdown pages listed in the official sitemap on 2026-06-18. - Official-doc corrections were applied to
agent.ts, route auth, channel integration, client/frontend, eval CLI, and responsible use. - Eve is Beta, so this crosswalk should be refreshed on every meaningful Eve upgrade.
Method
The official site exposes Markdown alternates for docs pages. This crosswalk was built from https://eve.dev/docs/<path>.md files discovered through sitemap.xml.
Key Corrections Applied
| Correction | Handbook location |
|---|---|
| Beta status and deployer responsibility | index, Ch15 |
root agent.ts can be omitted, but present agent.ts requires model | Ch5 |
scaffold placeholderAuth() vs framework default auth | Ch9 |
| official channel adapters and delivery/HITL/auth behavior | Ch9 |
useEveAgent, session cursor, clientContext, framework integrations | Ch9 |
eve eval CLI options, artifacts, reporter/judge/target split | Ch12 |
Start And Authoring Surface
| Doc | Handbook |
|---|---|
| Introduction | Ch1, index |
| Getting Started | Ch3, Ch5 |
| agent.ts | Ch5 |
| Instructions | Ch6 |
| Tools | Ch7 |
| Human-in-the-loop | Ch7 |
| Skills | Ch6 |
| Connections | Ch7 |
| Sandbox | Ch8 |
| Schedules | Ch11 |
| Subagents | Ch10 |
| Responsible Use | Ch15 |
Concepts
| Doc | Handbook |
|---|---|
| Context Control | Ch6 |
| The Harness | Ch4, Ch7, Ch8 |
| Execution Model and Durability | Ch1, Ch13 |
| Security Model | Ch8, Ch15 |
| Sessions, Runs & Streaming | Ch9 |
Channels
| Doc | Handbook |
|---|---|
| Overview | Ch9 |
| eve | Ch9 |
| Custom Channels | Ch9 |
| Slack | Ch9, Ch14 |
| Discord | Ch9 |
| GitHub | Ch9, Ch14 |
| Linear | Ch9, Ch14 |
| Microsoft Teams | Ch9 |
| Telegram | Ch9 |
| Twilio | Ch9 |
Operational Guides
| Doc | Handbook |
|---|---|
| Auth & Route Protection | Ch9, Ch15 |
| Deployment | Ch13 |
| Dev TUI | Ch13 |
| Dynamic Capabilities | Ch6 |
| Dynamic Workflows | Ch10 |
| Hooks | Ch11 |
| instrumentation.ts | Ch13 |
| Remote Agents | Ch10 |
| Session Context | Ch11 |
| State | Ch11 |
Evals
| Doc | Handbook |
|---|---|
| Overview | Ch12 |
| Assertions | Ch12 |
| Cases | Ch12 |
| Judge | Ch12 |
| Reporters | Ch12 |
| Running Evals | Ch12 |
| Targets | Ch12 |
Client And Frontend
| Doc | Handbook |
|---|---|
| TypeScript SDK Overview | Ch9 |
| Messages | Ch9 |
| Continuations | Ch9 |
| Streaming | Ch9 |
| Output Schema | Ch5, Ch9 |
| Frontend Overview | Ch9 |
| Next.js | Ch9, Ch13 |
| Nuxt | Ch9, Ch13 |
| SvelteKit | Ch9, Ch13 |
| useEveAgent (Svelte) | Ch9 |
| useEveAgent (Vue) | Ch9 |
Reference
| Doc | Handbook |
|---|---|
| CLI | Ch12, Ch13 |
| Project Layout | Ch3 |
| TypeScript API | Ch2, Ch5, Ch7 |
Tutorial
| Doc | Handbook |
|---|---|
| Your First Agent | Ch3, Ch5 |
| How It Runs | Ch1 |
| Query Sample Data | Ch7 |
| Connect a Warehouse | Ch7 |
| Run Analysis | Ch8, Ch14 |
| Remember Definitions | Ch11 |
| Team Playbooks | Ch6 |
| Guard the Spend | Ch7, Ch12 |
| Ship It | Ch9, Ch13 |
Maintenance Rules
| Change | Action |
|---|---|
| Eve package upgrade | compare local packages/eve/docs with eve.dev/docs |
| official sitemap changes | update this crosswalk and meta pages |
| auth/channel docs change | revisit Ch9 and Ch15 |
| eval CLI changes | update Ch12 CI commands |
| sandbox/backend changes | update Ch8 and Ch13 |