-
Notifications
You must be signed in to change notification settings - Fork 84
docs: remove quick wallet setup admonishment - set testnet as the default in client_config.yaml #2655
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?
Conversation
|
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.
Thanks for the PR, @wbbradley. I am missing some context for this change though.
| ```admonish tip title="Quick wallet setup" | ||
| If you just want to set up a new Sui wallet for Walrus, you can generate one using the | ||
| `walrus generate-sui-wallet --sui-network mainnet` command after [installing Walrus](#installation). | ||
| You still need to obtain some SUI and WAL tokens, but you do not have to install the Sui CLI. | ||
| ``` | ||
|
|
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.
Can you elaborate on what is "non-functional" about the resulting setup? Also, we should probably change or remove the corresponding CLI command.
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.
There has been feedback from UX research that while this tip is helpful to folks that need that particular route, it leaves naive users in a less than ideal position because the reality is that to work with accounts, one generally needs sui. And, in the long run, it's best that folks using the CLI grow accustomed to the sui CLI. Also, asking a brand-new user "If you just want to set up a new Sui wallet for Walrus" is a distraction from learning since the user has no idea at this point whether or to what extent they will or won't need just this, or something more. In other words, we can't expect new users to be informed enough at this juncture to understand this question and its potential outcomes. It's possible that we could rephrase it such that it explicitly filters out new users, but that is also just noise to a new user.
Yes, I agree that Walrus users can entirely live without awareness of (or usage of) the walrus generate-sui-wallet command. I'll log a Linear task to investigate removal of that command.
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.
I'm trying to find the "non-functional" bit in internal conversations with UX researchers (I'm pulling that from memory at the moment), but I think it amounts to the fact that once you've generated a sui wallet, in order to manipulate it at all, you will generally still need the sui CLI. So, in that sense, the generate-sui-wallet command is only a partial optimization for power users that already have the sui CLI installed.
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.
OK, happy to remove this admonition.
| rpc_urls: | ||
| - https://fullnode.testnet.sui.io:443 | ||
| default_context: mainnet | ||
| default_context: testnet |
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 context here is also based on feedback from usability tests. People do not want to be accidentally thrust into mainnet when they are learning.
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.
Makes sense. Then I'd suggest to also remove/change this admonition.
570af9d to
9084d51
Compare
9084d51 to
da94d14
Compare
| rpc_urls: | ||
| - https://fullnode.testnet.sui.io:443 | ||
| default_context: mainnet | ||
| default_context: testnet |
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.
Makes sense. Then I'd suggest to also remove/change this admonition.
| ```admonish tip title="Quick wallet setup" | ||
| If you just want to set up a new Sui wallet for Walrus, you can generate one using the | ||
| `walrus generate-sui-wallet --sui-network mainnet` command after [installing Walrus](#installation). | ||
| You still need to obtain some SUI and WAL tokens, but you do not have to install the Sui CLI. | ||
| ``` | ||
|
|
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.
OK, happy to remove this admonition.
Description
Remove "Quick Wallet Setup" admonishment that leads people into a non-functional setup and set testnet as the default.
Test plan
CI Pipeline.