-
Notifications
You must be signed in to change notification settings - Fork 196
docs: fix example imports & twoslash #2060
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
How to use the Graphite Merge QueueAdd the label graphite-merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes example imports and applies TypeScript two-slash (twoslash
) annotations to code blocks across React hook documentation files. The changes ensure proper TypeScript type checking and code validation in the documentation examples.
Key changes:
- Adds missing import statements to code examples that were previously omitted
- Applies
twoslash
annotation to TypeScript/TSX code blocks for enhanced type checking - Corrects code block language specifications (tsx vs ts)
Reviewed Changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
docs/pages/reference/account-kit/react/hooks/*.mdx | Adds twoslash annotations and missing imports to documentation examples |
account-kit/react/src/hooks/*.ts | Updates JSDoc examples with twoslash annotations and missing imports in source code |
docs/pages/reference/account-kit/react/hooks/useSolanaSignMessage.mdx
Outdated
Show resolved
Hide resolved
🌿 Documentation Preview
|
Pull Request Checklist
yarn test
)site
folder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change
)yarn lint:check
) and fix any issues? (yarn lint:write
)PR-Codex overview
This PR primarily focuses on updating example code snippets in various hooks and documentation files for consistency and clarity. The changes involve modifying code block formatting and imports to enhance readability.
Detailed summary
tsx
tots
in various files.useSendCalls
,usePrepareCalls
, and others.