-
Notifications
You must be signed in to change notification settings - Fork 150
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
Update account create docs #2517
base: master
Are you sure you want to change the base?
Conversation
docs/src/starknet/account.md
Outdated
You can also pass common `--accounts-file` argument with a path to (existing or not existing) file where you want to save account info. | ||
By default, the account details are saved in `~/.starknet_accounts/starknet_open_zeppelin_accounts.json`. | ||
|
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.
Let's add a Advanced Use Cases
heading below, just above Custom Account Contract
and include specifying accounts-file
as another usecase.
docs/src/starknet/account.md
Outdated
Note that you don't have to pass `url`, `accounts-file` parameters if `add-profile` flag | ||
was set in the `account create` command. Just pass `profile` argument with the account name. |
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.
In the example above you are not passing --accounts-file
though, which is a bit confusing.
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.
Also, this flag should be clearly explained in a paragraph above. It is never introduced and the example above even says it was not set.
@@ -117,8 +119,15 @@ For a detailed CLI description, see [account delete command reference](../append | |||
|
|||
List all accounts saved in `accounts file`, grouped based on the networks they are defined on. |
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'd remove all examples of --acounts-file
from this section. They can be added in advanced uses cases along with account create --accounts-file
.
docs/src/starknet/account.md
Outdated
@@ -82,18 +90,10 @@ Salt will not be randomly generated if it's specified with `--salt`. | |||
```shell | |||
$ sncast \ | |||
account create \ | |||
--url http://127.0.0.1:5050 \ |
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'd move ### ``account create`` With Salt Argument
to advanced use cases as well.
Closes #2508
Introduced changes
Checklist
CHANGELOG.md