-
Notifications
You must be signed in to change notification settings - Fork 102
docs: Update documentation for AppKit v1.7.17 features #592
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
base: main
Are you sure you want to change the base?
docs: Update documentation for AppKit v1.7.17 features #592
Conversation
- Add documentation for new Sui and Stacks networks - Add AppKitProvider React component documentation - Add new React components (AppKitButton, AppKitNetworkButton) - Update wallet button documentation with enhanced multichain support - Update useAppKitWallet hook with new multichain examples - Maintain consistency across all framework implementations Related to AppKit commit: f5a4040b944cc7685a65def14f1c181604e19770 Co-Authored-By: unknown <>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
@devin-ai-integration[bot] Please review the tone of voice for the content changes in this PR against Reown's brand guidelines. 📝 Content Review RequestFiles to review: 7
Review focus:
Guidelines summary:
Please analyze the content changes and provide constructive feedback on tone and voice alignment. |
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 updates the AppKit documentation to reflect new features introduced in version 1.7.17, focusing on enhanced multichain support and new React components. The documentation adds support for Sui and Stacks blockchain networks while introducing improved React integration patterns.
Key changes include:
- Added comprehensive documentation for Sui and Stacks network support
- Introduced new React components (AppKitProvider, AppKitButton, AppKitNetworkButton) with enhanced TypeScript integration
- Enhanced multichain wallet button functionality with improved namespace targeting across all frameworks
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
File | Description |
---|---|
appkit/networks/sui.mdx | New documentation for Sui blockchain integration with demo links and framework support |
appkit/networks/stacks.mdx | New documentation for Stacks blockchain integration with demo links and framework support |
appkit/react/core/installation.mdx | Added AppKitProvider component documentation for easier React integration |
appkit/react/core/components.mdx | Documented new React components (AppKitButton, AppKitNetworkButton) with TypeScript support |
appkit/react/core/hooks.mdx | Enhanced useAppKitWallet hook documentation with multichain examples |
appkit/vue/core/wallet-buttons.mdx | Added enhanced multichain examples for Vue framework |
appkit/next/core/components.mdx | Added enhanced multichain examples for Next.js framework |
appkit/javascript/core/actions.mdx | Added enhanced multichain examples for vanilla JavaScript |
</button> | ||
</div> | ||
) | ||
} | ||
|
||
// Usage | ||
<Button onClick={() => connectEVM("metamask")}>Connect MetaMask (EVM)</Button> |
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.
This line appears to be orphaned code that doesn't belong to any code block or example. It should either be removed or properly integrated into a complete example.
Copilot uses AI. Check for mistakes.
<video | ||
controls | ||
className="w-full aspect-video" | ||
src="/images/Sui.mp4" | ||
></video> |
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.
The video file path references '/images/Sui.mp4' but there's no indication this file exists. Consider verifying the file exists or providing a placeholder until the video is available.
<video | |
controls | |
className="w-full aspect-video" | |
src="/images/Sui.mp4" | |
></video> | |
<div className="w-full aspect-video flex items-center justify-center bg-gray-100 text-gray-500"> | |
<span>Video coming soon</span> | |
</div> |
Copilot uses AI. Check for mistakes.
<video | ||
controls | ||
className="w-full aspect-video" | ||
src="/images/Stacks.mp4" | ||
></video> |
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.
The video file path references '/images/Stacks.mp4' but there's no indication this file exists. Consider verifying the file exists or providing a placeholder until the video is available.
<video | |
controls | |
className="w-full aspect-video" | |
src="/images/Stacks.mp4" | |
></video> | |
{/* | |
Video with fallback placeholder if file is missing | |
*/} | |
import { useState } from 'react'; | |
function StacksVideo() { | |
const [error, setError] = useState(false); | |
return ( | |
<> | |
{!error ? ( | |
<video | |
controls | |
className="w-full aspect-video" | |
src="/images/Stacks.mp4" | |
onError={() => setError(true)} | |
></video> | |
) : ( | |
<div className="w-full aspect-video flex items-center justify-center bg-gray-100 text-gray-500"> | |
Video unavailable. Placeholder will be shown until the video is available. | |
</div> | |
)} | |
</> | |
); | |
} | |
<StacksVideo /> |
Copilot uses AI. Check for mistakes.
**AppKit provides a simple, secure, and seamless in-app experience for users looking to transact within the Sui ecosystem.** | ||
|
||
<Card title="Try Demo" href="https://appkit-lab.reown.com/library/sui/" horizontal /> | ||
|
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.
The demo link points to 'https://appkit-lab.reown.com/library/sui/' but there's no verification this URL exists and is accessible. Consider confirming the demo is live before documenting it.
> **Note:** The demo link may be temporarily unavailable. If you encounter issues accessing the demo, please check back later or contact support. |
Copilot uses AI. Check for mistakes.
Description
This PR updates the AppKit documentation to reflect the new features introduced in version 1.7.17, based on the changelog from commit f5a4040b944cc7685a65def14f1c181604e19770.
Major Changes:
New Network Support Documentation
appkit/networks/sui.mdx
for Sui blockchain supportappkit/networks/stacks.mdx
for Stacks blockchain supportReact Framework Updates
appkit/react/core/installation.mdx
appkit/react/core/components.mdx
useAppKitWallet
hook documentation with multichain examples inappkit/react/core/hooks.mdx
Cross-Framework Consistency
eip155
,solana
, andbip122
Key Features Documented:
Tests
Direct link to the deployed preview files
Review Checklist
Critical Items to Verify:
pnpm dev
to ensure all new documentation renders correctlyRequested by: User via Slack #system-devin
Link to Devin run: https://app.devin.ai/sessions/70f2fd67dc5742d289b51b96da685669
Reviewers
@reown-com/appkit-web-team @reown-com/devrel-team