Skip to content

docs(eve): documentation - reorganize and humanize#198

Closed
AndrewBarba wants to merge 1 commit into
mainfrom
barba/docs-cleanup-deslop
Closed

docs(eve): documentation - reorganize and humanize#198
AndrewBarba wants to merge 1 commit into
mainfrom
barba/docs-cleanup-deslop

Conversation

@AndrewBarba

@AndrewBarba AndrewBarba commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

This rebuilds the docs around human tasks while keeping the raw Markdown precise enough for coding agents working from node_modules/eve/docs.

Major differences

  • Mixed hierarchy → task-based navigation: Introducing eve, Quickstart, Build an Agent, Develop, Connect, Operate, Concepts, and Reference now give each page one clear role.
  • Broad setup docs → one working path: the new Quickstart uses the correct defaults and ends with a typed tool and concrete verification.
  • Private-beta tutorial → local, runnable tutorial: warehouse access and Python are replaced with tools, a real subagent, sandbox files, state, skills, approval, and a local web UI.
  • Compressed specification prose → candid maintainer guidance: narrative pages recommend defaults, explain surprising behavior, and name simpler alternatives and current limitations; reference remains terse.
  • Repeated framework/provider prose → shared contracts: client state, channel capabilities, and common behavior are documented once; provider pages focus on operational differences.
  • Partial reference → source-checked contracts: CLI, package exports, HTTP API, stream events, environment compatibility, and terminology now have dedicated references.
  • Incidental packaged docs → supported interface: the package-local README provides offline task routing, exact paths, imports, defaults, failure modes, and verification steps.
  • Basic checks → corpus guardrails: CI now catches broken links and anchors, orphan or duplicate routes, missing export coverage, package omissions, and stale canonical examples.

Impact

  • Documentation URLs intentionally change without redirects.
  • The published eve runtime API is unchanged.
  • All repository-owned links and machine-readable docs guidance use the new structure.
  • Canonical examples compile across tools, providers, auth, connections, channels, React, Vue, Svelte, Next.js, Nuxt, and SvelteKit.

Validation

  • pnpm docs:check and pnpm docs:check:examples
  • pnpm --filter eve-docs build and pnpm build
  • pnpm typecheck, pnpm lint, pnpm fmt, and pnpm guard:invariants
  • pnpm test:unit — 3,831 tests passed
  • pnpm test:integration — 368 tests passed
  • Clean tarball install with all 100 files under node_modules/eve/docs
  • Cumulative compilation of the tutorial's nine authored TypeScript files

Credentialed model calls, direct-provider network requests, and production deployments were not run because this environment does not provide the required external credentials.

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
eve-docs Ready Ready Preview, Comment, Open in v0 Jun 23, 2026 1:02am

@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Bundle + Package Summary: apps/fixtures/weather-agent

Key takeaways

  • No notable deltas vs main (b4fc7ac).

Delta vs main (b4fc7ac)

Area Metric Baseline Current Delta
Package Packed tarball 3.29 MB 3.28 MB -6.6 kB ✅
Package Unpacked publish size 11.85 MB 11.82 MB -34.6 kB ✅
Package Installed footprint 52.06 MB 52.02 MB -34.6 kB ✅
Package Published files 2239 2261 +22
Package Installed files 5444 5466 +22
Runtime Unique function payloads 2 2 0
Runtime Total function bytes 9.35 MB 9.35 MB -176 B ✅
Runtime Public routes 9 9 0
Changed function payloads vs main (b4fc7ac) (2)
Function Status Baseline Current Delta Route changes
functions/__server.func changed 3.87 MB 3.87 MB -144 B ✅ none
functions/.well-known/workflow/v1/flow.func changed 5.48 MB 5.48 MB -32 B ✅ none
Build Metadata
  • Preset: vercel
  • Nitro: nitro@3.0.260610-beta
  • Output directory: apps/fixtures/weather-agent/.vercel/output
  • Build metadata timestamp: 2026-06-23T01:03:01.111Z
  • Route aliases: 9 public, 1 internal (10 total aliases)
  • Vercel routes in config: 10
  • Severity legend: 🔴 dominant/large, 🟠 notable, 🟡 watch, ⚪ small
Package Drill-Down

Package Details

  • Package: eve@0.13.0
  • Package directory: packages/eve
  • Tarball: 3.28 MB (eve-0.13.0.tgz)
  • Unpacked payload: 11.82 MB across 2261 published files
  • Installed footprint: 52.02 MB across 5466 installed files
  • Installed root package: 10.71 MB
  • Installed dependencies: 41.32 MB
  • Runtime dependencies: 1
  • Peer dependencies: 12 (11 optional)

Installed footprint is measured from an isolated temporary npm install of the packed tarball.

Heavy installed dependencies

  • @rolldown/binding-linux-x64-gnu: 20.61 MB (39.6%)
  • eve: 10.71 MB (20.6%)
  • ai: 6.20 MB (11.9%)
  • zod: 4.97 MB (9.5%)
  • nitro: 2.41 MB (4.6%)
Publish payload breakdown
Published file size
🟠 dist/src/compiled/experimental-ai-sdk-code-mo... [####....................] 1.51 MB 12.7%
🟡 dist/src/compiled/@workflow/core/runtime.js      [##......................] 775.4 kB 6.6%
🟡 dist/src/compiled/@vercel/sandbox/index.js       [##......................] 632.0 kB 5.3%
🟡 dist/src/compiled/@chat-adapter/slack/index.js   [#.......................] 436.9 kB 3.7%
🟡 dist/src/compiled/_chunks/workflow/attribute-... [#.......................] 370.9 kB 3.1%
🔴 Other published files                            [########################] 8.10 MB 68.5%
Installed footprint breakdown
Installed package size
🔴 @rolldown/binding-linux-x64-gnu [########################] 20.61 MB 39.6%
🔴 eve                             [############............] 10.71 MB 20.6%
🔴 ai                              [#######.................] 6.20 MB 11.9%
🟠 zod                             [######..................] 4.97 MB 9.5%
🟠 nitro                           [###.....................] 2.41 MB 4.6%
🟡 rolldown                        [#.......................] 771.0 kB 1.5%
🔴 Other installed packages        [#######.................] 6.37 MB 12.2%
Runtime dependencies (1)
Package Range Notes
nitro 3.0.260610-beta
Peer dependencies (12)
Package Range Notes
@opentelemetry/api ^1.0.0 optional peer
@sveltejs/kit ^2.0.0 optional peer
ai catalog:
braintrust ^3.0.0 optional peer
just-bash ^3.0.0 optional peer
microsandbox ^0.5.0 optional peer
next ^16.0.0 optional peer
nuxt ^4.0.0 optional peer
react ^19.0.0 optional peer
svelte ^5.0.0 optional peer
vite ^8.0.0 optional peer
vue ^3.5.0 optional peer
Function Drill-Down

Payload Size Graph

Unique function payload size and share of total
🔴 functions/.well-known/workflow/v1/flow.func     [########################] 5.48 MB 58.6%
🔴 functions/__server.func                         [#################.......] 3.87 MB 41.4%

Top Function Payloads

🟠 functions/.well-known/workflow/v1/flow.func • 1 public route • 5.48 MB
Metric Value
Public routes /.well-known/workflow/v1/flow
Runtime nodejs24.x
Handler index.mjs
Payload 5.48 MB
Function files 5.48 MB across 27 files
Traced dependencies 0 B
Signal 🟠 Bundled file __eve_nitro_handler__.mjs is 1.51 MB (27.6%)

🟠 🔎 Dependency Analysis

📦 Bundled files:

Bundled file size
🟠 __eve_nitro_handler__.mjs              [########################] 1.51 MB 27.6%
🟠 _chunks/runtime.mjs                    [###############.........] 958.4 kB 17.5%
🟡 _chunks/sandbox.mjs                    [############............] 766.0 kB 14.0%
🟡 _chunks/attribute-changes-Bi5DLT8S.mjs [########................] 472.2 kB 8.6%
🟡 _chunks/dist-DTchiX0N.mjs              [#######.................] 460.6 kB 8.4%
🟠 Other bundled files                    [#####################...] 1.31 MB 24.0%

🧾 Vercel Config

{
  "handler": "index.mjs",
  "launcherType": "Nodejs",
  "shouldAddHelpers": false,
  "supportsResponseStreaming": true,
  "runtime": "nodejs24.x",
  "environment": {
    "NODE_OPTIONS": "--experimental-require-module",
    "WORKFLOW_QUEUE_NAMESPACE": "eve"
  },
  "maxDuration": "max",
  "experimentalTriggers": [
    {
      "type": "queue/v2beta",
      "topic": "__eve_wkf_workflow_*",
      "consumer": "default",
      "retryAfterSeconds": 5,
      "initialDelaySeconds": 0
    }
  ]
}

🟠 functions/__server.func • 8 public routes, 1 internal alias • 3.87 MB
Metric Value
Public routes /
/eve/v1/callback/[token]
/eve/v1/connections/[name]/callback/[token]
/eve/v1/health
/eve/v1/info
/eve/v1/session
/eve/v1/session/[sessionId]
/eve/v1/session/[sessionId]/stream
Internal aliases /__server
Runtime nodejs24.x
Handler index.mjs
Payload 3.87 MB
Function files 3.87 MB across 21 files
Traced dependencies 0 B
Signal 🟠 Bundled file index.mjs is 1.40 MB (36.3%)

🟠 🔎 Dependency Analysis

📦 Bundled files:

Bundled file size
🟠 index.mjs                              [########################] 1.40 MB 36.3%
🟠 _chunks/runtime.mjs                    [###############.........] 875.8 kB 22.6%
🟠 _chunks/sandbox.mjs                    [#############...........] 766.0 kB 19.8%
🟡 _chunks/attribute-changes-Bi5DLT8S.mjs [########................] 448.5 kB 11.6%
⚪ _libs/zod.mjs                          [##......................] 114.2 kB 3.0%
🟡 Other bundled files                    [####....................] 258.8 kB 6.7%

🧾 Vercel Config

{
  "handler": "index.mjs",
  "launcherType": "Nodejs",
  "shouldAddHelpers": false,
  "supportsResponseStreaming": true,
  "runtime": "nodejs24.x"
}

@AndrewBarba AndrewBarba force-pushed the barba/docs-cleanup-deslop branch from aa5b84b to 3740487 Compare June 22, 2026 23:04
@AndrewBarba AndrewBarba changed the title docs(eve): documentation - reorganize and de-SLOP docs(eve): documentation - reorganize and humanize Jun 22, 2026
@AndrewBarba AndrewBarba force-pushed the barba/docs-cleanup-deslop branch from 3740487 to 7f233fa Compare June 22, 2026 23:10
@AndrewBarba AndrewBarba force-pushed the barba/docs-cleanup-deslop branch from 7f233fa to a7b05bc Compare June 23, 2026 00:46
Rebuild the documentation around user tasks while preserving exact paths, APIs, defaults, and examples for coding agents. Add package-local navigation and stronger documentation validation.

Signed-off-by: Andrew Barba <barba@hey.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant