Skip to content

docs: align the beta changelog, AI SDK pages and migration guide with gen_ai and @evlog/eve - #1136

Open
HugoRCD wants to merge 1 commit into
v3from
fix/pre-release-audit
Open

HugoRCD wants to merge 1 commit into
v3from
fix/pre-release-audit

Conversation

@HugoRCD

@HugoRCD HugoRCD commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

Written by an AI agent on behalf of @HugoRCD. @HugoRCD has reviewed it.

Fixes from the pre-release audit of evlog 3.0.0-beta.3 (#1017). Everything is on v3; nothing had to go to main, whose 2.36.0 changelog (#1016) matches what merged. No changeset: this PR only edits changesets, docs and an example.

Beta changelog (#1017)

Changeset Problem Fix
eve-v27-events.md (#1019, synced from main) Tells beta.3 readers that defineEvlogHook() from evlog/eve now reads eve 0.84 events, in the same release that removes evlog/eve (#1134) Deleted. The 2.36.0 changelog on main keeps it
gen-ai-fields.md (#1131) Says the block moves "for evlog/ai and evlog/eve" Names @evlog/eve, which emits gen_ai.conversation.id, agent.name and operation.name (packages/eve/extension/lib/turn.ts)
lazy-pretty-ai.md (#1117) Names the pretty keys ai.tokens, ai.tools, ai.steps, which #1131 renamed gen_ai.usage, gen_ai.tools, gen_ai.response (src/shared/pretty-ai.ts)

AI field examples left on the 2.x shape after #1131

#1131 updated the metadata page and the migration guide, but these still showed camelCase ai.* events. Each now matches toGenAIField() in src/ai/gen-ai.ts (time_to_first_chunk in seconds, finish_reasons as an array):

  • 5.use-cases/2.ai-sdk/01.overview.md, 02.usage.md (two events), 03.options.md, 05.telemetry.md
  • 5.use-cases/3.better-auth/05.performance.md
  • 6.extend/3.consumer-recipes.md (the cost recipe read e.ai?.estimatedCost, which is now always undefined)
  • app/components/content/AiSdkWideEvent.vue and app/components/features/FeatureAiSdk.vue (landing)
  • examples/eve/app/_components/evlog-events-panel.tsx read event.ai?.tools, so after feat(eve)!: ship evlog for eve as the @evlog/eve extension #1134 the example's event panel never tagged tool calls
-  "ai": {
-    "model": "claude-sonnet-4.6",
-    "inputTokens": 3312,
-    "finishReason": "stop",
-    "msToFirstChunk": 234,
+  "gen_ai": {
+    "request": { "model": "claude-sonnet-4.6" },
+    "usage": { "input_tokens": 3312, ... },
+    "response": { "finish_reasons": ["stop"], "time_to_first_chunk": 0.234, ... }

Migration guide (7.reference/9.migrate-v3.md)

Validation

  • pnpm run lint, pnpm run typecheck, pnpm run test: exit 0 at this head.
  • pnpm content:lint on every edited page: no new findings. The 4 T-15 findings on the migration guide were already on v3; they are the "before" imports (evlog/browser, evlog/nitro/v3, createPostHogEventsDrain) the guide has to show.
  • Docs rendered locally: the AI SDK overview's wide-event panel lists all 12 gen_ai rows on one line each with none overflowing (DOM check plus screenshot, kept in the agent thread, not committed). On the landing, the gen_ai.* list fits its column (DOM check). Its animation does not start in headless Chrome, so there is no screenshot of its final state.
ELI5

The next 3.0 beta renamed where AI numbers live in a log event, and moved the eve integration to its own package. Some docs pages, an example app and two release notes still described the old layout. This updates them so what users read matches what they install.

@vercel

vercel Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
evi Ready Ready Preview Nov 18, 2026 9:38am UTC
evlog-docs Ready Ready Preview, v0 Nov 18, 2026 9:38am UTC
evlog-render-lab Ready Ready Preview Nov 18, 2026 9:38am UTC
evlog-telemetry Ready Ready Preview Nov 18, 2026 9:38am UTC
just-use-evlog Ready Ready Preview Nov 18, 2026 9:38am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 67d07f25-8c99-4c0b-8115-56ba215770a1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@github-actions

Copy link
Copy Markdown
Contributor

Risk score: Very high (4/4)

Assessed at 439ace2 from the changed files and the title, by scripts/risk-score. A new push replaces this score.

  • On merge: deploys the docs and sites
  • evlog core: Compatibility: a changeset declares a major bump
  • 13 files changed (237 lines), 0 of them tests
Area Level Why
evlog core Very high Compatibility: a changeset declares a major bump
Docs and sites Low Changes pages, content or published skills: content/AiSdkWideEvent.vue, features/FeatureAiSdk.vue, 2.ai-sdk/01.overview.md and 6 more
Examples and repository Low Examples, playgrounds or agent guidance: _components/evlog-events-panel.tsx

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@pkg-pr-new

pkg-pr-new Bot commented Nov 18, 2026

Copy link
Copy Markdown
@evlog/cli

npm i https://pkg.pr.new/evloghq/evlog/@evlog/cli@1136

@evlog/eve

npm i https://pkg.pr.new/evloghq/evlog/@evlog/eve@1136

evlog

npm i https://pkg.pr.new/evloghq/evlog@1136

@evlog/nuxthub

npm i https://pkg.pr.new/evloghq/evlog/@evlog/nuxthub@1136

@evlog/signals

npm i https://pkg.pr.new/evloghq/evlog/@evlog/signals@1136

@evlog/telemetry

npm i https://pkg.pr.new/evloghq/evlog/@evlog/telemetry@1136

commit: 439ace2

This branch was successfully deployed

5 active deployments
Preview – evlog-docs — 439ace2e Deployed Nov 18, 2026 by vercel[bot]
Preview – evlog-telemetry — 439ace2e Deployed Nov 18, 2026 by vercel[bot]
Preview – evi — 439ace2e Deployed Nov 18, 2026 by vercel[bot]
Preview – just-use-evlog — 439ace2e Deployed Nov 18, 2026 by vercel[bot]
Preview – evlog-render-lab — 439ace2e Deployed Nov 18, 2026 by vercel[bot]
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