diff --git a/docs/base-account/contribute/contribute-to-base-account-docs.mdx b/docs/base-account/contribute/contribute-to-base-account-docs.mdx index 11c92bf5..83370baa 100644 --- a/docs/base-account/contribute/contribute-to-base-account-docs.mdx +++ b/docs/base-account/contribute/contribute-to-base-account-docs.mdx @@ -19,12 +19,14 @@ Good documentation significantly accelerates developer adoption. Focus on creati The Base Account documentation is organized into the following main sections: -1. **Quickstart** -2. **Concepts** +1. **Introduction** +2. **Quickstart** 3. **Guides** -4. **Examples** -5. **Technical Reference** -6. **Contribute** +4. **Framework Integrations** +5. **Reference** +6. **More** +7. **Basenames** +8. **Contribute** **Do not create new top-level sections** @@ -37,55 +39,77 @@ The Base Account documentation is organized into the following main sections: When adding new content, determine the appropriate section based on the following criteria: +#### Introduction + +- High-level explanatory content about what Base Account is and its core value proposition +- Update only when there are fundamental changes to the product positioning or capabilities + #### Quickstart - End-to-end guides for getting developers up and running quickly - Should remain focused and concise -- Update only when there are fundamental changes to the initial setup process - -#### Concepts - -- Explanatory content about Base Account components, architecture, and design philosophy -- Add new concept documentation when introducing fundamentally new capabilities or paradigms -- Subsections include: - - Intro - - Built-in Features - - Optional Features - - Additional conceptual topics as needed +- Covers different integration paths (web, web with React, mobile) #### Guides - Step-by-step tutorials for specific tasks and implementation scenarios -- **All guides should live under the main "Guides" section** -- Avoid creating deep hierarchical subsections unless absolutely necessary -- Try to keep the number of subsections to a minimum, preferably only one page per guide -- Although not required, guides should preferably have an accompanying GitHub repository -- Name guides clearly with action-oriented titles (e.g., "Implementing Multi-Signature Verification" rather than "Multi-Sig Guide") - -#### Examples - -- Complete, working code examples demonstrating real-world use cases -- Each example should be self-contained and fully functional -- Each example should have an accompanying GitHub repository -- Include comments explaining key implementation details -- Examples should cover all of the built-in and optional features of the Base Account - -#### Technical Reference +- Includes guides for authentication, payments, and UX improvements +- Covers features like: + - User authentication + - Accepting payments and recurring payments + - Batch transactions + - Paymasters and gas sponsorship + - Sub Accounts + - Spend Permissions + - Magic Spend +- Name guides clearly with action-oriented titles (e.g., "Accept Payments" rather than "Payments Guide") + +#### Framework Integrations + +- Detailed integration guides for specific frameworks and libraries +- Subsections organized by framework: + - **Wagmi/Viem**: Setup, batch transactions, Basenames, and other use cases + - **Privy**: Setup, authentication, wallet actions, and sub-accounts + - **CDP**: Coinbase Developer Platform integration + - **RainbowKit**: Integration with RainbowKit +- Each framework section should cover setup and common use cases + +#### Reference - Comprehensive technical documentation of APIs, methods, components, and configurations - Structured reference material rather than tutorial content - Include parameter descriptions, return values, and usage examples -- All technical specifications for new features go here, not in separate sections +- Organized by component: + - **Account SDK**: Core functions, Spend Permission utilities, Base Pay, subscriptions, and Prolink utilities + - **Provider**: Methods (RPC methods like `wallet_connect`, `wallet_sendCalls`, etc.) and Capabilities + - **UI Elements**: Base Pay Button, Sign In With Base Button, brand guidelines + - **Onchain Contracts**: Spend permissions, smart wallet, and Basenames contracts + +#### More + +- Additional resources and supplementary documentation +- Troubleshooting guides (popups, gas usage, unsupported calls, simulations, wallet library support) +- Base Gasless Campaign information +- Telemetry information +- Migration guides + +#### Basenames + +- Documentation specific to Basenames functionality +- FAQs and common questions +- Basename transfer documentation #### Contribute - Information for contributors to the Base Account project +- Security and bug bounty information - Update when contribution processes change **Avoiding Subsection Proliferation** - **For Guides**: Keep all guides at the same level under the Guides section -- **For Technical Reference**: Organize by component or feature, not by use case +- **For Reference**: Organize by component or feature, not by use case +- **For Framework Integrations**: Keep framework-specific content within its respective framework subsection - When tempted to add a new subsection, consider if the content could be reorganized to fit existing sections - Use cross-referencing between related content rather than creating new organizational structures diff --git a/docs/docs.json b/docs/docs.json index 6bf263c1..1a189ef6 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -242,6 +242,17 @@ "group": "Account SDK", "pages": [ "base-account/reference/core/createBaseAccount", + "base-account/reference/core/getProvider", + "base-account/reference/spend-permission-utilities/requestSpendPermission", + "base-account/reference/spend-permission-utilities/prepareSpendCallData", + "base-account/reference/spend-permission-utilities/fetchPermissions", + "base-account/reference/spend-permission-utilities/fetchPermission", + "base-account/reference/spend-permission-utilities/getPermissionStatus", + "base-account/reference/spend-permission-utilities/requestRevoke", + "base-account/reference/spend-permission-utilities/prepareRevokeCallData", + "base-account/reference/core/generateKeyPair", + "base-account/reference/core/getKeypair", + "base-account/reference/core/getCryptoKeyAccount", { "group": "Base Pay", "pages": [ @@ -269,18 +280,7 @@ "base-account/reference/prolink-utilities/decodeProlink", "base-account/reference/prolink-utilities/createProlinkUrl" ] - }, - "base-account/reference/core/getProvider", - "base-account/reference/spend-permission-utilities/requestSpendPermission", - "base-account/reference/spend-permission-utilities/prepareSpendCallData", - "base-account/reference/spend-permission-utilities/fetchPermissions", - "base-account/reference/spend-permission-utilities/fetchPermission", - "base-account/reference/spend-permission-utilities/getPermissionStatus", - "base-account/reference/spend-permission-utilities/requestRevoke", - "base-account/reference/spend-permission-utilities/prepareRevokeCallData", - "base-account/reference/core/generateKeyPair", - "base-account/reference/core/getKeypair", - "base-account/reference/core/getCryptoKeyAccount" + } ] }, { @@ -387,8 +387,8 @@ "group": "Basenames", "pages": [ "base-account/basenames/basenames-faq", - "base-account/basenames/basename-transfer", - "base-account/basenames/basenames-onchainkit-tutorial" ] + "base-account/basenames/basename-transfer" + ] }, { "group": "Contribute", @@ -547,7 +547,10 @@ }, { "group": "Fund", - "pages": ["onchainkit/latest/components/fund/fund-button", "onchainkit/latest/components/fund/fund-card"] + "pages": [ + "onchainkit/latest/components/fund/fund-button", + "onchainkit/latest/components/fund/fund-card" + ] }, { "group": "Identity", @@ -563,7 +566,10 @@ }, { "group": "Mint", - "pages": ["onchainkit/latest/components/mint/nft-card", "onchainkit/latest/components/mint/nft-mint-card"] + "pages": [ + "onchainkit/latest/components/mint/nft-card", + "onchainkit/latest/components/mint/nft-mint-card" + ] }, { "group": "MiniKit", @@ -589,11 +595,16 @@ }, { "group": "Signature", - "pages": ["onchainkit/latest/components/signature/signature"] + "pages": [ + "onchainkit/latest/components/signature/signature" + ] }, { "group": "Swap", - "pages": ["onchainkit/latest/components/swap/swap", "onchainkit/latest/components/swap/swap-settings"] + "pages": [ + "onchainkit/latest/components/swap/swap", + "onchainkit/latest/components/swap/swap-settings" + ] }, { "group": "Token", @@ -607,7 +618,9 @@ }, { "group": "Transaction", - "pages": ["onchainkit/latest/components/transaction/transaction"] + "pages": [ + "onchainkit/latest/components/transaction/transaction" + ] }, { "group": "Wallet", @@ -623,7 +636,9 @@ }, { "group": "Connected", - "pages": ["onchainkit/latest/components/connected/connected"] + "pages": [ + "onchainkit/latest/components/connected/connected" + ] } ] }, @@ -1450,12 +1465,11 @@ "icon": "discord" } ], - "primary": - { - "type": "button", - "label": "Base Build", - "href": "https://base.dev" - } + "primary": { + "type": "button", + "label": "Base Build", + "href": "https://base.dev" + } }, "footer": { "socials": {