Skip to content

docs: index Chat SDK types with Vellum - #129

Merged
Tom Tang (qwerzl) merged 1 commit into
mainfrom
agent/index-chat-vellum
Aug 5, 2026
Merged

docs: index Chat SDK types with Vellum#129
Tom Tang (qwerzl) merged 1 commit into
mainfrom
agent/index-chat-vellum

Conversation

@qwerzl

@qwerzl Tom Tang (qwerzl) commented Aug 5, 2026

Copy link
Copy Markdown
Member

Summary

  • add Chat SDK 4.34.0 as a docs development dependency
  • include chat in Vellum's TypeScript package index
  • allow synced docs templates to resolve Chat SDK symbols such as Message and Thread

Why

The Eve integration page uses Vellum references for Chat SDK callback types. The aggregator did not install or index chat, so those references could not resolve in every build. Pinning 4.34.0 matches the Chat SDK version currently used by Eve.

Validation

  • pnpm install --frozen-lockfile
  • pnpm docs:generate (655 symbols extracted, 85 templates rendered)
  • isolated Vellum render for ts:chat#Message and ts:chat#Thread
  • pnpm lint
  • pnpm typecheck:docs
  • git diff --check

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.


Note

Low Risk
Docs tooling and dependency wiring only; no changes to auth, runtime services, or production app code.

Overview
Adds chat 4.34.0 as a dev dependency and registers it in vellum.config.ts so the TypeScript extractor indexes Chat SDK symbols alongside the other Photon packages.

This lets Vellum references (e.g. Message, Thread) resolve in doc generation—needed for pages like Eve integration that document Chat SDK callback types. The lockfile picks up chat’s markdown/remark-related transitive deps; no application runtime code changes.

Reviewed by Cursor Bugbot for commit 11b7b7e. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Chores
    • Added the chat package to development tooling.
    • Updated TypeScript configuration formatting and package extraction settings.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 699f9579-bdeb-4c60-af5c-24b8323480dc

📥 Commits

Reviewing files that changed from the base of the PR and between b20664b and 11b7b7e.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • package.json
  • vellum.config.ts

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

The change adds chat@4.34.0 to development dependencies and includes chat in the TypeScript package extraction configuration.

Changes

Chat package integration

Layer / File(s) Summary
Register chat package
package.json, vellum.config.ts
Adds chat@4.34.0 to development dependencies and includes chat in the extracted package list.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: lingjueya

Poem

A rabbit adds a package with care,
“Chat” now joins the bundle there.
The config grows neat and bright,
Dependencies hop into sight.
Ears up—this change is light!

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/index-chat-vellum

Comment @coderabbitai help to get the list of available commands.

@qwerzl
Tom Tang (qwerzl) marked this pull request as ready for review August 5, 2026 20:27
Copilot AI review requested due to automatic review settings August 5, 2026 20:27
@qwerzl
Tom Tang (qwerzl) merged commit 73741af into main Aug 5, 2026
6 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

github-actions Bot added a commit that referenced this pull request Aug 5, 2026
Resolves pnpm-lock.yaml conflicts introduced by the chat/eve dependency
additions on main (#129, #130) landing alongside the spectrum-ts 12.5.0
bump on this branch.

Both conflicts were in the @eslint-community/eslint-utils peer-dep keys:
main's 4.9.1(eslint@9.39.4) resolution is kept over this branch's
4.10.1(eslint@9.39.4(jiti@2.6.1)), matching the surrounding merged
snapshot bodies. The orphaned 4.10.1 packages: entry is dropped.

package.json merged cleanly: spectrum-ts 12.5.0 from this branch plus
chat 4.34.0 and eve 0.30.8 from main.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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.

2 participants