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 various docs #1345

Merged
merged 17 commits into from
Feb 12, 2025
Merged

docs: add various docs #1345

merged 17 commits into from
Feb 12, 2025

Conversation

Zer0dot
Copy link
Collaborator

@Zer0dot Zer0dot commented Feb 10, 2025

Pull Request Checklist

Adds pages for MAv2 overview, benchmarks, and choosing a smart account.


PR-Codex overview

This PR focuses on updating the smart-contracts documentation, enhancing the information about gas benchmarks and the Modular Account V2. It introduces new content and links for better user guidance on smart account functionalities and comparisons.

Detailed summary

  • Updated link in site/sidebar/smart-contracts.ts to point to new gas benchmarks page.
  • Added new gas-benchmarks.mdx file detailing gas costs for various smart accounts.
  • Created modular-account-v2/overview.mdx with an overview of Modular Account V2 features and benefits.
  • Revised choosing-a-smart-account.mdx to emphasize the advantages of smart accounts and provide detailed comparisons.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented Feb 10, 2025

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

Name Status Preview Comments Updated (UTC)
aa-sdk-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 11, 2025 11:46pm
aa-sdk-ui-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 11, 2025 11:46pm

Copy link

graphite-app bot commented Feb 10, 2025

How to use the Graphite Merge Queue

Add the label graphite-merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

@Zer0dot Zer0dot changed the title feat: add Choosing a Smart Account page docs: Add Various Docs Feb 10, 2025
@Zer0dot Zer0dot force-pushed the zer0dot/docs-benchmarks branch from 2fe3974 to ae6b75b Compare February 10, 2025 22:25
@Zer0dot Zer0dot force-pushed the zer0dot/docs-benchmarks branch from 6993a13 to 70c1b75 Compare February 11, 2025 01:11
@Zer0dot Zer0dot marked this pull request as ready for review February 11, 2025 01:11
@Zer0dot Zer0dot changed the title docs: Add Various Docs docs: add Various Docs Feb 11, 2025
@Zer0dot Zer0dot force-pushed the zer0dot/docs-benchmarks branch from 3d03678 to d5ef518 Compare February 11, 2025 23:31
@avarobinson avarobinson changed the base branch from main to docs-staging February 12, 2025 00:48
@Zer0dot Zer0dot merged commit 199eee0 into docs-staging Feb 12, 2025
7 checks passed
@Zer0dot Zer0dot deleted the zer0dot/docs-benchmarks branch February 12, 2025 00:56
howydev pushed a commit that referenced this pull request Feb 14, 2025
* feat: add Choosing a Smart Account page

* chore: lint

* feat: benchmarks

* feat: add mav2 overview

* docs: update table to display diff from MAv2 as a percentage increase

* docs: adding in feature table and other account details

* docs: updating copy

* docs: updating multisig

* chore: cleanup gas benchmarks, remove runtime column

* docs: clarify safe 4337 module

* docs: remove sidebar link

* docs: remove repeated table, add details

* docs: mention ERC-4337

* docs: link audits, clarify legacy contracts

* docs: rename legacy to other

* docs: specify MAv2 breaking the sub-100k gas barrier

* chore: format

---------

Co-authored-by: Ava Robinson <[email protected]>
howydev added a commit that referenced this pull request Feb 14, 2025
* docs: add ma v2 page (#1340)

* docs: add ma v2 page

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* fix: review fixes

* chore: remove comment to standardize

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* fix: imports in example

* fix: lint

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* chore: make it consistent

---------

Co-authored-by: avarobinson <[email protected]>

* docs: add various docs (#1345)

* feat: add Choosing a Smart Account page

* chore: lint

* feat: benchmarks

* feat: add mav2 overview

* docs: update table to display diff from MAv2 as a percentage increase

* docs: adding in feature table and other account details

* docs: updating copy

* docs: updating multisig

* chore: cleanup gas benchmarks, remove runtime column

* docs: clarify safe 4337 module

* docs: remove sidebar link

* docs: remove repeated table, add details

* docs: mention ERC-4337

* docs: link audits, clarify legacy contracts

* docs: rename legacy to other

* docs: specify MAv2 breaking the sub-100k gas barrier

* chore: format

---------

Co-authored-by: Ava Robinson <[email protected]>

* docs: restructure smart accounts layout (#1342)

* docs: add ma v2 page

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* fix: review fixes

* chore: remove comment to standardize

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* fix: imports in example

* fix: lint

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* chore: make it consistent

* docs: restructure smart accounts layout

* fix: pr review

* Update site/pages/concepts/intro-to-account-kit.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/resources/terms.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/resources/terms.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/resources/terms.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/choosing-a-smart-account.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/install-plugins.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/sidebar/smart-contracts.ts

Co-authored-by: avarobinson <[email protected]>

* fix: broken linksg

---------

Co-authored-by: avarobinson <[email protected]>
Co-authored-by: Ava Robinson <[email protected]>

* docs: adds set up useSmartAccountClient page and updates code examples to use mav2 (#1343)

* docs: fixes typo

* docs: updating guide to clean up account types and sidebar;

* docs: cleaning up configs and advanced table

* docs: fixing copy

* docs: updating type param to be optional

* docs: adds missing parameter definitions and fixes typos

* docs: adds wording modifications

* docs: fixing merge conflict

---------

Co-authored-by: Ava Robinson <[email protected]>

* docs: updating sidebar for mav2 (#1348)

* docs: add ma v2 page

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* fix: review fixes

* chore: remove comment to standardize

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* fix: imports in example

* fix: lint

* Update site/pages/smart-contracts/modular-account-v2/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/modular-account/getting-started.mdx

Co-authored-by: avarobinson <[email protected]>

* chore: make it consistent

* docs: restructure smart accounts layout

* fix: pr review

* Update site/pages/concepts/intro-to-account-kit.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/resources/terms.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/resources/terms.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/resources/terms.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/choosing-a-smart-account.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/pages/smart-contracts/install-plugins.mdx

Co-authored-by: avarobinson <[email protected]>

* Update site/sidebar/smart-contracts.ts

Co-authored-by: avarobinson <[email protected]>

* fix: broken linksg

* docs: re-arranging sidebar for new account layout and updating references

* chore: readd lost commit from ava

---------

Co-authored-by: howydev <[email protected]>

* docs: adds using 7702 react page (#1350)

* docs: adds 7702 react page

* docs: adds note about gas sponsorship

* docs: add note about getting access to testnet

* docs: adding 7702 details

* docs: modifies copy

* docs: adds ERC-4337 account benefits

* docs: fixing link

---------

Co-authored-by: Ava Robinson <[email protected]>

* docs: adds mode and 7702 info to smart-contracts docs (#1354)

* docs: moving 7702, updating link

* fix: running lint

* fix: broken links

* feat: add 7702 doc in smart-contracts (#1351)

* feat: add 7702 doc in smart-contracts

* fix: typo

* fix: review fixes

* docs: Apply suggestions from code review

* feat: move sc 7702 doc

* docs: changing desc

---------

Co-authored-by: avarobinson <[email protected]>
Co-authored-by: Ava Robinson <[email protected]>

* docs: fix code examples

* docs: temporarily remove accountParams from useSmartAccountClient reference

* docs: adds updated pregenerated docs

* docs: wraps sendUserOperation arguments in uo object

* Update site/pages/react/using-7702.mdx

Co-authored-by: Lisa Ma <[email protected]>

* Update site/pages/react/using-7702.mdx

Co-authored-by: Lisa Ma <[email protected]>

* Update site/pages/react/using-7702.mdx

Co-authored-by: Lisa Ma <[email protected]>

* Update site/pages/react/using-7702.mdx

Co-authored-by: Lisa Ma <[email protected]>

* Update site/pages/react/using-7702.mdx

Co-authored-by: Lisa Ma <[email protected]>

* fix: pr reviews

* Update site/pages/react/send-user-operations.mdx

Co-authored-by: Linna <[email protected]>

---------

Co-authored-by: howy <[email protected]>
Co-authored-by: Zer0dot <[email protected]>
Co-authored-by: Linna <[email protected]>
Co-authored-by: Adam Egyed <[email protected]>
Co-authored-by: linna <[email protected]>
Co-authored-by: Lisa Ma <[email protected]>
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.

4 participants