Skip to content

docs: index Eve Photon channel types - #130

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

docs: index Eve Photon channel types#130
Tom Tang (qwerzl) merged 1 commit into
mainfrom
agent/index-eve-vellum

Conversation

@qwerzl

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

Copy link
Copy Markdown
Member

Summary

  • add eve@0.30.8 as a docs development dependency
  • index the eve/channels/photon package entry point with Vellum
  • enable synced docs to extract PhotonIMessageChannelConfig and generate the Photon channel options table directly from Eve's types and JSDoc

Why

The Eve integration page should not maintain a second hand-written list of channel options. Indexing the exported SDK interface keeps option names, types, requiredness, defaults, and descriptions aligned with Eve, including the previously omitted events option.

Impact

Eve depends on Nitro and has an AI SDK peer, so the lockfile expansion is larger than the two-line configuration change. Vellum indexes only the Photon channel subpath and extracts seven additional public symbols.

Validation

  • pnpm install --frozen-lockfile
  • isolated Vellum render of the local Eve integration page (458 symbols extracted, two templates rendered)
  • pnpm docs:generate (662 symbols extracted, 85 templates rendered)
  • 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-only dependency and Vellum source configuration; no production runtime or auth/data-path changes, though the lockfile churn is large.

Overview
Adds eve@0.30.8 as a dev dependency and registers eve/channels/photon in vellum.config.ts so the TypeScript extractor can pull Eve’s Photon channel SDK types (e.g. PhotonIMessageChannelConfig) into the docs pipeline.

That lets the Eve integration page generate channel option tables from exported types and JSDoc instead of maintaining a separate hand-written list. The lockfile grows mainly from Eve’s transitive stack (Nitro, AI SDK, rolldown, etc.), not from broad new app runtime dependencies.

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

Summary by CodeRabbit

  • Chores
    • Updated development tooling configuration to support the latest build and development setup.
    • Included additional source packages in the project’s TypeScript processing configuration.

@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: cd17f6b1-2cca-4f96-bdd7-00123dfa2c01

📥 Commits

Reviewing files that changed from the base of the PR and between 73741af and bfb7dc2.

⛔ 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 project adds Eve version 0.30.8 as a development dependency and includes eve/channels/photon in the Vellum TypeScript source packages.

Changes

Eve integration

Layer / File(s) Summary
Add Eve development and source configuration
package.json, vellum.config.ts
The project declares Eve version 0.30.8 and includes eve/channels/photon in the Vellum TypeScript sources.

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

Suggested reviewers: lingjueya

Poem

A rabbit hops through package rows,
Eve joins where the source path flows.
Photon beams now shine in view,
Vellum knows the channel too.
One small hop, the setup’s bright!

✨ 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-eve-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:40
Copilot AI review requested due to automatic review settings August 5, 2026 20:40
@qwerzl
Tom Tang (qwerzl) merged commit ecc00e5 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