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

[docs] Add docs for wallet hooks and components in dapp-kit #14127

Merged
merged 6 commits into from
Oct 11, 2023

Conversation

hayes-mysten
Copy link
Contributor

@hayes-mysten hayes-mysten commented Oct 5, 2023

Description

https://sui-typescript-docs-git-mh-dapp-kit-wallet-docs-mysten-labs.vercel.app/dapp-kit

Test Plan

How did you test the new or updated feature?


If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.

Type of Change (Check all that apply)

  • protocol change
  • user-visible impact
  • breaking change for a client SDKs
  • breaking change for FNs (FN binary must upgrade)
  • breaking change for validators or node operators (must upgrade binaries)
  • breaking change for on-chain data layout
  • necessitate either a data wipe or data migration

Release notes

@hayes-mysten hayes-mysten requested a review from a team as a code owner October 5, 2023 23:11
@vercel
Copy link

vercel bot commented Oct 5, 2023

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

Name Status Preview Comments Updated (UTC)
sui-typescript-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2023 2:23am
4 Ignored Deployments
Name Status Preview Comments Updated (UTC)
explorer ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2023 2:23am
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2023 2:23am
mysten-ui ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2023 2:23am
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Oct 11, 2023 2:23am

@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2023

⚠️ 🦋 Changesets Warning: This PR has changes to public npm packages, but does not contain a changeset. You can create a changeset easily by running pnpm changeset in the root of the Sui repo, and following the prompts. If your change does not need a changeset (e.g. a documentation-only change), you can ignore this message. This warning will be removed when a changeset is added to this pull request.

Learn more about Changesets.

Copy link
Contributor

@williamrobertson13 williamrobertson13 left a comment

Choose a reason for hiding this comment

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

took a skim through and lgtm for our initial set of docs! will let technical writing sign off

sdk/docs/pages/dapp-kit/wallet-hooks/useCurrentWallet.mdx Outdated Show resolved Hide resolved
sdk/docs/examples/wallet-hooks.tsx Show resolved Hide resolved
sdk/docs/pages/dapp-kit/themes.mdx Outdated Show resolved Hide resolved
sdk/docs/pages/dapp-kit/themes.mdx Show resolved Hide resolved

<UseWalletsExample />

## Wallet properties
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally there'd be good wallet standard docs to point to since this is really just a wallet standard object.

sdk/docs/pages/dapp-kit/wallet-hooks/useSwitchAccount.mdx Outdated Show resolved Hide resolved
@hayes-mysten hayes-mysten enabled auto-merge (squash) October 11, 2023 02:22
@hayes-mysten hayes-mysten merged commit fe37f45 into main Oct 11, 2023
33 of 34 checks passed
@hayes-mysten hayes-mysten deleted the mh--dapp-kit-wallet-docs branch October 11, 2023 02:35
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.

3 participants