Skip to content

Commit

Permalink
docs: add base skeleton for docs refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
moldy530 committed Jun 20, 2024
1 parent 20dda22 commit 78b2f76
Show file tree
Hide file tree
Showing 7 changed files with 428 additions and 335 deletions.
6 changes: 6 additions & 0 deletions site/pages/core/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: TODO
description: TODO
---

TODO
6 changes: 6 additions & 0 deletions site/pages/infra/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: TODO
description: TODO
---

TODO
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
---
outline: deep
head:
- - meta
- property: og:title
content: Migrating to aa-sdk v3
- - meta
- name: description
content: How to upgrade through breaking changes of aa-sdk v3
- - meta
- property: og:description
content: How to upgrade through breaking changes of aa-sdk v3.
- - meta
- name: twitter:title
content: Migration Guide
- - meta
- name: twitter:description
content: How to upgrade through breaking changes of aa-sdk v3.
title: Migration Guide
description: How to upgrade through breaking changes of the aa-sdk and account-kit
---

# Migration Guide
Expand Down Expand Up @@ -89,7 +75,7 @@ const client = createSmartAccountClient({ // [!code ++]
### Client: signature changes on methods
To support [the various ways](/migration-guides/migrating-to-v3#account-connecting-to-a-smart-account) of connecting to a smart account, the signatures of the methods on `SmartAccountClient` have changed. Almost all methods now have an optional param for `account` and have been converted into single argument functions that take an object with the their properties instead.
To support [the various ways](/migration-guide#account-connecting-to-a-smart-account) of connecting to a smart account, the signatures of the methods on `SmartAccountClient` have changed. Almost all methods now have an optional param for `account` and have been converted into single argument functions that take an object with the their properties instead.
### Account: `BaseSmartContractAccount``SmartContractAccount`
Expand Down
6 changes: 6 additions & 0 deletions site/pages/signer/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: TODO
description: TODO
---

TODO
6 changes: 6 additions & 0 deletions site/pages/smart-contracts/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: TODO
description: TODO
---

TODO
324 changes: 324 additions & 0 deletions site/sidebar/old.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,324 @@
import { aaAccountsSidebar } from "./aa-accounts.js";
import { aaAlchemySidebar } from "./aa-alchemy.js";
import { aaCoreSideBar } from "./aa-core.js";
import { aaEthersSidebar } from "./aa-ethers.js";
import { aaSignersSidebar } from "./aa-signers.js";

export const oldSidebar = [
// old sidebar: TODO: delete this
{
text: "Getting started",
items: [
{
text: "Overview",
link: "/getting-started/overview",
},
{
text: "Quick start app",
items: [
{ text: "Demo", link: "/getting-started/introduction" },
{
text: "Run locally",
link: "/getting-started/run-locally",
},
{
text: "Walkthrough",
link: "/getting-started/walkthrough",
},
],
},
],
},
{
text: "Using Alchemy Signer",
items: [
{
text: "Introduction",
link: "/signers/alchemy-signer/introduction",
},
{
text: "Passkey signup",
link: "/signers/alchemy-signer/passkey-signup",
},
{
text: "Passkey authentication",
link: "/signers/alchemy-signer/passkey-auth",
},
{
text: "User sessions",
link: "/signers/alchemy-signer/manage-user-sessions",
},
{
text: "Export private key",
link: "/signers/alchemy-signer/export-private-key",
},
],
},
{
text: "Using smart accounts",
items: [
{
text: "Send user operations",
link: "/using-smart-accounts/send-user-operations",
},
{
text: "Batch user operations",
link: "/using-smart-accounts/batch-user-operations",
},
{
text: "Sponsor gas",
collapsed: false,
items: [
{
text: "Use the Gas Manager",
link: "/using-smart-accounts/sponsoring-gas/gas-manager",
},
{
text: "Check eligibility",
link: "/using-smart-accounts/sponsoring-gas/checking-eligibility",
},
],
},
{
text: "Simulate user operations",
link: "/using-smart-accounts/simulate-user-operations",
},
{
text: "Session keys",
collapsed: false,
items: [
{
text: "Overview",
link: "/using-smart-accounts/session-keys/",
},
{
text: "Getting started",
link: "/using-smart-accounts/session-keys/getting-started",
},
{
text: "Supported permissions",
link: "/using-smart-accounts/session-keys/supported-permissions",
},
],
},
{
text: "Transfer ownership",
collapsed: false,
items: [
{
text: "Modular Account",
link: "/using-smart-accounts/transfer-ownership/modular-account",
},
{
text: "Light Account",
link: "/using-smart-accounts/transfer-ownership/light-account",
},
{
text: "Multi-Owner Light Account",
link: "/using-smart-accounts/transfer-ownership/multi-owner-light-account",
},
],
},
{
text: "Alchemy enhanced APIs",
collapsed: false,
items: [
{
text: "Get account NFTs",
link: "/using-smart-accounts/enhanced-apis/nft",
},
{
text: "Get account tokens",
link: "/using-smart-accounts/enhanced-apis/token",
},
],
},
],
},
{
text: "React Hooks",
items: [
{ text: "Overview", link: "/react/overview" },
{ text: "SSR", link: "/react/ssr" },
{ text: "createConfig", link: "/react/createConfig" },
{ text: "useAuthenticate", link: "/react/useAuthenticate" },
{ text: "useSmartAccountClient", link: "/react/useSmartAccountClient" },
{ text: "useClientActions", link: "/react/useClientActions" },
{ text: "useAccount", link: "/react/useAccount" },
{ text: "useSigner", link: "/react/useSigner" },
{ text: "useSignerStatus", link: "/react/useSignerStatus" },
{ text: "useUser", link: "/react/useUser" },
{ text: "useBundlerClient", link: "/react/useBundlerClient" },
{ text: "useAddPasskey", link: "/react/useAddPasskey" },
{ text: "useLogout", link: "/react/useLogout" },
{ text: "useExportAccount", link: "/react/useExportAccount" },
{ text: "useSignMessage", link: "/react/useSignMessage" },
{ text: "useSignTypedData", link: "/react/useSignTypedData" },
{ text: "useSendUserOperation", link: "/react/useSendUserOperation" },
{
text: "useDropAndReplaceUserOperation",
link: "/react/useDropAndReplaceUserOperation",
},
{
text: "useWaitForUserOperationTransaction",
link: "/react/useWaitForUserOperationTransaction",
},
{ text: "useSendTransaction", link: "/react/useSendTransaction" },
{ text: "useSendTransactions", link: "/react/useSendTransactions" },
{ text: "useChain", link: "/react/useChain" },
],
},
{
text: "Choosing a smart account",
items: [
{ text: "Introduction", link: "/smart-accounts/" },
{
text: "Modular Account",
collapsed: false,
items: [
{ text: "Introduction", link: "/smart-accounts/modular-account/" },
{
text: "Getting started",
link: "/smart-accounts/modular-account/getting-started",
},
{
text: "Deployments",
link: "/smart-accounts/modular-account/deployments",
},
{
text: "Upgrading to Modular Account",
link: "/smart-accounts/modular-account/upgrade-la-to-ma",
},
{
text: "Multisig Plugin",
collapsed: true,
items: [
{
text: "Introduction",
link: "/smart-accounts/modular-account/multisig-plugin/",
},
{
text: "Getting started",
link: "/smart-accounts/modular-account/multisig-plugin/getting-started",
},
{
text: "Technical details",
link: "/smart-accounts/modular-account/multisig-plugin/technical-details",
},
],
},
],
},
{
text: "Light Account",
collapsed: false,
items: [
{ text: "Overview", link: "/smart-accounts/light-account/" },
{
text: "Getting started",
link: "/smart-accounts/light-account/getting-started",
},
{
text: "Deployments",
link: "/smart-accounts/light-account/deployments",
},
],
},
{
text: "Custom accounts",
collapsed: true,
items: [
{
text: "Use your own",
link: "/smart-accounts/custom/using-your-own",
},
{
text: "Contribute your account",
link: "/smart-accounts/custom/contributing",
},
],
},
{ text: "Gas benchmarks", link: "/smart-accounts/gas-benchmarks" },
],
},
{
text: "Extending smart accounts",
items: [
{
text: "Install plugins",
link: "/extending-smart-accounts/install-plugins",
},
{
text: "Get installed plugins",
link: "/extending-smart-accounts/get-installed-plugins",
},
],
},
{
text: "Custom signers",
items: [
{ text: "Introduction", link: "/signers/choosing-a-signer" },
{
text: "Third-party signers",
collapsed: true,
items: [
{ text: "Magic", link: "/signers/guides/magic" },
{ text: "Web3Auth", link: "/signers/guides/web3auth" },
{ text: "Turnkey", link: "/signers/guides/turnkey" },
{ text: "Privy", link: "/signers/guides/privy" },
{ text: "Dynamic", link: "/signers/guides/dynamic" },
{ text: "Fireblocks", link: "/signers/guides/fireblocks" },
{ text: "Portal", link: "/signers/guides/portal" },
{ text: "Capsule", link: "/signers/guides/capsule" },
{ text: "Lit Protocol", link: "/signers/guides/lit" },
{
text: "Particle Network",
link: "/signers/guides/particle-network",
},
{ text: "Arcana Auth", link: "/signers/guides/arcana-auth" },
{ text: "Dfns", link: "/signers/guides/dfns" },
{ text: "WalletKit", link: "/signers/guides/walletkit" },
{ text: "Passport", link: "/signers/guides/passport" },
],
},
{ text: "EOA signer", link: "/signers/eoa" },
{
text: "Build your own",
link: "/signers/guides/custom-signer",
},
{
text: "Contribute your signer",
link: "/signers/contributing",
},
],
},

{
text: "Custom infra",
items: [
{ text: "Use custom bundler", link: "/third-party/bundlers" },
{ text: "Use custom paymaster", link: "/third-party/paymasters" },
],
},
{
text: "aa-sdk packages",
items: [
{ text: "Overview", link: "/packages/" },
aaCoreSideBar,
aaAlchemySidebar,
aaAccountsSidebar,
aaSignersSidebar,
aaEthersSidebar,
],
},
{
text: "Resources",
items: [
{ text: "FAQs", link: "/resources/faqs" },
{ text: "React Native", link: "/resources/react-native" },
{ text: "Terms", link: "/resources/terms" },
{ text: "Types", link: "/resources/types" },
{ text: "Contact us", link: "/resources/contact-us" },
],
},
];
Loading

0 comments on commit 78b2f76

Please sign in to comment.