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

add Account Documentation #273

Merged
merged 6 commits into from
Jun 16, 2024
Merged

add Account Documentation #273

merged 6 commits into from
Jun 16, 2024

Conversation

jancris100
Copy link
Contributor

@jancris100 jancris100 commented May 15, 2024

Docs for sozo account #272

-New route to account.mdx
-Documentation to account

Copy link

vercel bot commented May 15, 2024

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

Name Status Preview Updated (UTC)
book ✅ Ready (Inspect) Visit Preview Jun 16, 2024 11:41am

Copy link
Collaborator

@lambda-0x lambda-0x left a comment

Choose a reason for hiding this comment

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

also we should also mention that we only support openzeppelin account variant (for more advance usecases they should use starkli) and also add an example.

you can refer to: https://book.starkli.rs/accounts

Comment on lines 6 to 9
The `sozo account` command allows managing accounts for the Sozo platform.
It provides functionalities to create new account configurations, deploy account contracts, and fetch
existing account configurations.
## Usage
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The `sozo account` command allows managing accounts for the Sozo platform.
It provides functionalities to create new account configurations, deploy account contracts, and fetch
existing account configurations.
## Usage
The `sozo account` command allows managing account contracts.
It provides functionalities to create new account configurations, deploying them, and fetch
account configuration for already existing account.
## Usage

@jancris100
Copy link
Contributor Author

Oh I haven't read this before I'm already getting to do it

[add] an example
@jancris100
Copy link
Contributor Author

Done the new changes @lambda-0x

Comment on lines 47 to 48
- `starknet`: Options for specifying StarkNet configuration.
- `signer`: Options for specifying the signer.
Copy link
Collaborator

Choose a reason for hiding this comment

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

can you please add more description for options that are not directly arguments, something like: https://book.dojoengine.org/toolchain/sozo/world-commands/execute#world-options.

so user can know exactly what argument they need to pass in the CLI.

Copy link
Collaborator

@lambda-0x lambda-0x left a comment

Choose a reason for hiding this comment

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

one small suggestions, otherwise LGTM.

@jancris100
Copy link
Contributor Author

OK on my way

@lambda-0x
Copy link
Collaborator

@jancris100 any updates on this?

@jancris100
Copy link
Contributor Author

Hello sorry for the delay I have had very busy weeks today I have time at night and I will update the documentation

@jancris100
Copy link
Contributor Author

Ready the update

@lambda-0x lambda-0x merged commit 446af4d into dojoengine:main Jun 16, 2024
1 check 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.

2 participants