Skip to content
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

added chain abstraction docs #199

Merged
merged 22 commits into from
Jan 3, 2025
Merged

added chain abstraction docs #199

merged 22 commits into from
Jan 3, 2025

Conversation

vrajdesai78
Copy link
Collaborator

Description

Added docs for chain abstraction

Tests

  • - Ran the changes locally with Docusaurus. and confirmed that the changes appear as expected.
  • - Applied the corrections suggested by Cspell on the .mdx files with changes.

Copy link

vercel bot commented Dec 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
reown-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 3, 2025 1:06pm

Copy link
Contributor

@jakubuid jakubuid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good start 🙏
@vrajdesai78

  • Can we add warnings that this feature of the WalletKit SDK is in an experimental phase?
  • What should be the structure per platform? It would be nice to follow the same structure to make the docs super easy to follow
  • It also would be useful to have a section that explains what wallets have to do in order to execute the fulfillment operation

@riveign
Copy link

riveign commented Dec 12, 2024

Thanks @vrajdesai78 ! In addition to what @jakubuid shared I would add

  • A warning explaining that this only works with apps that support it and that if they want to support it as an app they can look in the CA section for apps that we have on appkit now
  • Steps on how to implement the flow regardless of the technology since all the wallets need to do the same. Here we could add the flow diagram we have in the notion doc
  • Link for sample wallet + appkit lab to test
  • Also I would add a section on fees so devs can understand that there are many fees involved (gas and bridging fees)

@jakubuid
Copy link
Contributor

jakubuid commented Dec 12, 2024

One more thing from my side. We should provide testing instructions so that devs are not lost. What's the AppKit flow to trigger a test scenario, they will need to have ETH for gas and USDC on addresses. It should no brainer when they read the docs 🙏

We should also provide links to the sample wallets to showcase the implementation details wallet side

@chris13524 chris13524 mentioned this pull request Dec 12, 2024
2 tasks
Co-authored-by: Jakub Witczak <jakubwitczak6@gmail.com>
@jakubuid
Copy link
Contributor

@vrajdesai78
It seems we're still missing this part from @riveign comment:

  • A warning explaining that this only works with apps that support it and that if they want to support it as an app they can look in the CA section for apps that we have on appkit now

docusaurus.config.js Outdated Show resolved Hide resolved
Co-authored-by: Rohit Ramesh <70317502+rohit-710@users.noreply.github.com>
@vrajdesai78 vrajdesai78 merged commit f1c9c0e into main Jan 3, 2025
4 checks passed
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.

8 participants