docs: index Eve Photon channel types - #130
Merged
Merged
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
Disabled knowledge base sources:
📝 WalkthroughWalkthroughThe project adds Eve version ChangesEve integration
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: Poem
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
eve@0.30.8as a docs development dependencyeve/channels/photonpackage entry point with VellumPhotonIMessageChannelConfigand generate the Photon channel options table directly from Eve's types and JSDocWhy
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
eventsoption.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-lockfilepnpm docs:generate(662 symbols extracted, 85 templates rendered)pnpm lintpnpm typecheck:docsgit diff --checkNeed help on this PR? Tag
@codesmith-botwith 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.8as a dev dependency and registerseve/channels/photoninvellum.config.tsso 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