docs: adds streamlined quick start #697

Dan-Nolan · 2024-06-03T19:21:00Z

Pull Request Checklist

Did you add new tests and confirm existing tests pass? (yarn test)
Did you update relevant docs? (docs are found in the site folder, and guidelines for updating/adding docs can be found in the contribution guide)
Do your commits follow the Conventional Commits standard?
Does your PR title also follow the Conventional Commits standard?
If you have a breaking change, is it correctly reflected in your commit message? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:write)
Did you follow the contribution guidelines?

PR-Codex overview

This PR adds submodules, updates Node.js setup, and enhances the Embedded Accounts quickstart guide with new sections and content.

Detailed summary

Added submodules for recursive fetching
Updated Node.js setup
Enhanced Embedded Accounts quickstart guide with new sections and content

The following files were skipped due to too many changes: site/pages/getting-started/walkthrough.mdx

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

moldy530 · 2024-06-03T20:19:23Z

site/pages/getting-started/walkthrough.mdx

+First, let's do our configuration in a single file called `config.ts`.
+
+```ts [config.ts]
+// [!include ~/../examples/embedded-accounts-quickstart/src/config.ts:create-accounts-config]


does the create-accounts-config section render correctly? I can't remember if I had issues with region names that were kebab cased

Yup it works! I actually thought it was kebab casing for a minute, but I had to change the region comments in the aa-sdk repo. After that it worked fine ✅

moldy530

overall LGTM had one question about region names, but I think my issue was different

moldy530 · 2024-06-03T20:21:18Z

ah wait

./how-it-works.md in /home/runner/work/aa-sdk/aa-sdk/site/pages/getting-started/run-locally.mdx
./run-the-app.md in /home/runner/work/aa-sdk/aa-sdk/site/pages/getting-started/introduction.mdx
./how-it-works.md in /home/runner/work/aa-sdk/aa-sdk/site/pages/getting-started/introduction.mdx

you need to drop the extension on those files so they get rendered correctly

vercel · 2024-06-03T20:38:07Z

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	Jun 6, 2024 7:59pm

Dan-Nolan · 2024-06-03T20:38:43Z

good call, fixed the link extensions!

Dan-Nolan · 2024-06-03T20:51:16Z

actually, scratch that, the relative linking is off by one... 🤔

Dan-Nolan · 2024-06-03T21:20:45Z

checked all the links, working well ✅

moldy530 · 2024-06-04T23:00:30Z

you might need to rebase on top of vocs-docs

* run store hydration on window focus * remove logs

* feat: update button colors * fix: update test

* fix: allow nonzero paymaster override * refactor: update to use Hex type for paymasterAndData/paymasterData override * fix: add checks for paymasterData and paymaster field nonzero overrides * fix: add paymaster address override type * feat: gas manager only bypasses paymaster middleware when the UserOp paying for its own gas * fix: add signatures and overrides to fix 3/3 msig test and add paymaster test

* feat: switch type => variant and use type submit * fix: add custom focus state

)

* feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError

* docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com>

* docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: adds streamlined quick start * docs: drops the file extension on local quick start links * docs: fix relative routes across quick start * feat: run store hydration on window focus (#695) * run store hydration on window focus * remove logs * feat: update button colors (#696) * feat: update button colors * fix: update test * fix: plugins were missing mainnet config (#692) * fix: account hydration was missing state (#693) * chore: enable version syncing when publishing (#694) * chore(release): publish v3.18.0 [skip-ci] * fix: fix paymaster override for multisig plugin (#676) * fix: allow nonzero paymaster override * refactor: update to use Hex type for paymasterAndData/paymasterData override * fix: add checks for paymasterData and paymaster field nonzero overrides * fix: add paymaster address override type * feat: gas manager only bypasses paymaster middleware when the UserOp paying for its own gas * fix: add signatures and overrides to fix 3/3 msig test and add paymaster test * chore: rename button "type" to "variant" (#699) * feat: switch type => variant and use type submit * fix: add custom focus state * fix: update the version of the store so that we don't have clashes (#703) * chore(release): publish v3.18.1 [skip-ci] * chore(release): publish v3.18.2 [skip-ci] * feat: add updated error UI + custom error rendering (#705) * feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError * docs: add vercel json (#700) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> * chore: remove the docs publishing github action * docs: run locally meets dashboard quickstart * chore: update the gh actions to checkout submodules * chore: add embedded accounts submodule --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> Co-authored-by: Tina <59578595+tinaszheng@users.noreply.github.com> Co-authored-by: Alchemy Bot <alchemy-bot@alchemy.com> Co-authored-by: Zer0dot <zer0dot.dev@gmail.com> Co-authored-by: Cody McCabe <cmccabe524@gmail.com>

* docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json (#700) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> * chore: remove the docs publishing github action * docs: adds streamlined quick start (#697) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: adds streamlined quick start * docs: drops the file extension on local quick start links * docs: fix relative routes across quick start * feat: run store hydration on window focus (#695) * run store hydration on window focus * remove logs * feat: update button colors (#696) * feat: update button colors * fix: update test * fix: plugins were missing mainnet config (#692) * fix: account hydration was missing state (#693) * chore: enable version syncing when publishing (#694) * chore(release): publish v3.18.0 [skip-ci] * fix: fix paymaster override for multisig plugin (#676) * fix: allow nonzero paymaster override * refactor: update to use Hex type for paymasterAndData/paymasterData override * fix: add checks for paymasterData and paymaster field nonzero overrides * fix: add paymaster address override type * feat: gas manager only bypasses paymaster middleware when the UserOp paying for its own gas * fix: add signatures and overrides to fix 3/3 msig test and add paymaster test * chore: rename button "type" to "variant" (#699) * feat: switch type => variant and use type submit * fix: add custom focus state * fix: update the version of the store so that we don't have clashes (#703) * chore(release): publish v3.18.1 [skip-ci] * chore(release): publish v3.18.2 [skip-ci] * feat: add updated error UI + custom error rendering (#705) * feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError * docs: add vercel json (#700) * docs: revert revert to use vocs for docs * docs: address some of the broken things on the site (#689) * docs: update the logos for AK * docs: add vercel json * docs: add build script * docs: add rewrites for .html` * docs: try cleanUrls * docs: remove rewrites --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> * chore: remove the docs publishing github action * docs: run locally meets dashboard quickstart * chore: update the gh actions to checkout submodules * chore: add embedded accounts submodule --------- Co-authored-by: moldy <michael.moldoveanu@alchemy.com> Co-authored-by: Tina <59578595+tinaszheng@users.noreply.github.com> Co-authored-by: Alchemy Bot <alchemy-bot@alchemy.com> Co-authored-by: Zer0dot <zer0dot.dev@gmail.com> Co-authored-by: Cody McCabe <cmccabe524@gmail.com> --------- Co-authored-by: Cody McCabe <cmccabe524@gmail.com> Co-authored-by: Dan Nolan <dan.nolan@alchemy.com> Co-authored-by: Tina <59578595+tinaszheng@users.noreply.github.com> Co-authored-by: Alchemy Bot <alchemy-bot@alchemy.com> Co-authored-by: Zer0dot <zer0dot.dev@gmail.com>

moldy530 and others added 4 commits May 31, 2024 16:20

docs: revert revert to use vocs for docs

e75dc35

docs: address some of the broken things on the site (#689)

92f4af9

docs: update the logos for AK

6457da2

docs: adds streamlined quick start

4c4afca

Dan-Nolan requested review from moldy530, rthomare, dancoombs, mokok123 and dphilipson as code owners June 3, 2024 19:21

Dan-Nolan mentioned this pull request Jun 3, 2024

feat: new simplified quickstart #687

Closed

7 tasks

moldy530 reviewed Jun 3, 2024

View reviewed changes

moldy530 previously approved these changes Jun 3, 2024

View reviewed changes

docs: drops the file extension on local quick start links

83b0a4f

Dan-Nolan dismissed moldy530’s stale review via 83b0a4f June 3, 2024 20:38

vercel bot had a problem deploying to Preview June 3, 2024 20:45 Failure

docs: fix relative routes across quick start

54faa32

vercel bot had a problem deploying to Preview June 3, 2024 21:19 Failure

moldy530 force-pushed the vocs-docs branch 5 times, most recently from 4587b19 to f2be161 Compare June 4, 2024 20:48

moldy530 force-pushed the vocs-docs branch 2 times, most recently from e9bd3e9 to ba19b68 Compare June 5, 2024 16:07

tinaszheng and others added 15 commits June 6, 2024 13:10

feat: run store hydration on window focus (#695)

20724e0

* run store hydration on window focus * remove logs

feat: update button colors (#696)

ae3ef95

* feat: update button colors * fix: update test

fix: plugins were missing mainnet config (#692)

e0d9414

fix: account hydration was missing state (#693)

88820de

chore: enable version syncing when publishing (#694)

9b0da82

chore(release): publish v3.18.0 [skip-ci]

88cc97b

chore: rename button "type" to "variant" (#699)

4933169

* feat: switch type => variant and use type submit * fix: add custom focus state

fix: update the version of the store so that we don't have clashes (#703

c74d4ad

)

chore(release): publish v3.18.1 [skip-ci]

cd9e572

chore(release): publish v3.18.2 [skip-ci]

e3ec272

feat: add updated error UI + custom error rendering (#705)

aa16c05

* feat: add error boundary by id * fix: remove unused classnames * feat: use error from hook * fix: remove unused variables * fix: remove console log * fix: add new colors to test * feat: rename to useAuthError

chore: remove the docs publishing github action

1983044

Merge branch 'vocs-docs' into dn/streamlined-quickstart

24682e7

vercel bot had a problem deploying to Preview June 6, 2024 17:19 Failure

vercel bot had a problem deploying to Preview June 6, 2024 17:26 Failure

docs: run locally meets dashboard quickstart

5d324f5

vercel bot had a problem deploying to Preview June 6, 2024 19:37 Failure

chore: update the gh actions to checkout submodules

2060ed9

vercel bot had a problem deploying to Preview June 6, 2024 19:43 Failure

chore: add embedded accounts submodule

c95e18d

vercel bot deployed to Preview June 6, 2024 19:59 View deployment

moldy530 approved these changes Jun 6, 2024

View reviewed changes

moldy530 merged commit b7cf8b8 into vocs-docs Jun 6, 2024
5 checks passed

moldy530 deleted the dn/streamlined-quickstart branch June 6, 2024 20:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: adds streamlined quick start #697

docs: adds streamlined quick start #697

Dan-Nolan commented Jun 3, 2024 •

edited by pr-codex bot

Loading

moldy530 Jun 3, 2024

Dan-Nolan Jun 3, 2024

moldy530 left a comment

moldy530 commented Jun 3, 2024

vercel bot commented Jun 3, 2024 •

edited

Loading

Dan-Nolan commented Jun 3, 2024

Dan-Nolan commented Jun 3, 2024

Dan-Nolan commented Jun 3, 2024

moldy530 commented Jun 4, 2024

docs: adds streamlined quick start #697

docs: adds streamlined quick start #697

Conversation

Dan-Nolan commented Jun 3, 2024 • edited by pr-codex bot Loading

Pull Request Checklist

PR-Codex overview

Detailed summary

moldy530 Jun 3, 2024

Choose a reason for hiding this comment

Dan-Nolan Jun 3, 2024

Choose a reason for hiding this comment

moldy530 left a comment

Choose a reason for hiding this comment

moldy530 commented Jun 3, 2024

vercel bot commented Jun 3, 2024 • edited Loading

Dan-Nolan commented Jun 3, 2024

Dan-Nolan commented Jun 3, 2024

Dan-Nolan commented Jun 3, 2024

moldy530 commented Jun 4, 2024

Dan-Nolan commented Jun 3, 2024 •

edited by pr-codex bot

Loading

vercel bot commented Jun 3, 2024 •

edited

Loading