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

Fix docs sections structure inconsistencies #999

Merged

Conversation

ericnordelo
Copy link
Member

Fixes #829

Copy link
Collaborator

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

The changes look good, Eric! I left some minor comments. It looks like we still need to update the token module structures as well

To create an account, implement the {account-mixin} and set up the constructor to initialize the contract.
The {initializer} method sets the public key for the account contract and registers the account interface id.
A vanilla account contract looks like this:
First, let's take the example account we created before and deploy it:
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
First, let's take the example account we created before and deploy it:
First, let's take the example xref:accounts.adoc#usage[Starknet Account] we created before and deploy it:

What do you think of this? We could remove the duplicate snippet if we include the link. Maybe it's better to have it directly underneath anyway, idk. Just an idea

Copy link
Member Author

Choose a reason for hiding this comment

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

I think is easier for users to avoid going back and forth to check the code, I vote we keep the duplicate snippet.

docs/modules/ROOT/pages/access.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/accounts.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/accounts.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/accounts.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/accounts.adoc Show resolved Hide resolved
docs/modules/ROOT/pages/introspection.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/introspection.adoc Outdated Show resolved Hide resolved
ericnordelo and others added 8 commits June 11, 2024 12:18
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
…o/cairo-contracts into docs/fix-inconsistencies-#829
Copy link
Collaborator

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

LGTM!

@ericnordelo ericnordelo merged commit bc57953 into OpenZeppelin:main Jun 12, 2024
6 checks passed
@ericnordelo ericnordelo deleted the docs/fix-inconsistencies-#829 branch June 12, 2024 17:46
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.

Fix inconsistent section structure/order throughout docsite
2 participants