Point the Solana JSDoc at the packages that actually exist - #319
Merged
Conversation
The @example blocks on SolanaOptions.store and SolanaManager.setStore told users to `import { createClient } from '@solana-foundation/framework-kit'`. That package does not exist; npm returns a 404. framework-kit ships as `@solana/client` and `@solana/react-hooks`, which is what examples/with-solana depends on and what the docs instruct. SolanaOptions is the type users hover in their editor when wiring the Solana integration, so this is the first import they copy. The two prose mentions keep calling it framework-kit, which is correct as the project name; they just drop the bogus package scope. The examples also import `autoDiscover`, since both examples call it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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
1 participant
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.
Problem
The
@exampleblocks onSolanaOptions.storeandSolanaManager.setStore()tell users to:That package does not exist:
framework-kit ships as
@solana/client(1.7.0) and@solana/react-hooks(1.4.1), which is whatexamples/with-solanadepends on and what the docs instruct.SolanaOptionsis the type users hover in their editor while wiring the Solana integration, so this is the first import they copy.Changes
src/solana/types.ts@exampleimport →@solana/client; prose drops the bogus scopesrc/solana/SolanaManager.ts@exampleimport →@solana/clientsrc/solana/storeTypes.tsThe prose mentions still say framework-kit, which is correct as the project name; only the package scope was wrong. Both examples call
autoDiscover(), so the import now includes it.Comments only, no behavior change.
Verification
tsc --noEmit: exit 0, no errorsnpm test: 678 passing🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.