docs: reorder

wevm · Sep 8, 2023 · b0f87d9 · b0f87d9
1 parent ed12877
commit b0f87d9
Show file tree

Hide file tree

Showing 142 changed files with 240 additions and 307 deletions.
diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts
diff --git a/docs/core/actions.md → docs/core/api/actions.md b/docs/core/actions.md → docs/core/api/actions.md
@@ -1,9 +1,9 @@
 <script setup>
-import { getSidebar } from '../.vitepress/sidebar'
+import { getSidebar } from '../../.vitepress/sidebar'
 
 const actions = getSidebar()['/core']
   .find(x => x.text === 'API').items
-  .find(x => x.link === '/core/actions').items
+  .find(x => x.link === '/core/api/actions').items
   .sort((a, b) => a.text.localeCompare(b.text))
 </script>
 

diff --git a/docs/core/actions/connect.md → docs/core/api/actions/connect.md b/docs/core/actions/connect.md → docs/core/api/actions/connect.md
@@ -6,7 +6,7 @@ const typeName = 'Connect'
 
 # connect
 
-Action for connecting accounts with [connectors](/core/connectors).
+Action for connecting accounts with [connectors](/core/api/connectors).
 
 ## Import
 
@@ -60,7 +60,7 @@ const result = await connect(config, {
 
 `CreateConnectorFn | Connector`
 
-[Connector](/core/connectors) to connect with.
+[Connector](/core/api/connectors) to connect with.
 
 ::: code-group
 ```ts [index.ts]

diff --git a/docs/core/actions/disconnect.md → docs/core/api/actions/disconnect.md b/docs/core/actions/disconnect.md → docs/core/api/actions/disconnect.md
@@ -36,7 +36,7 @@ import { type DisconnectParameters } from '@wagmi/core'
 
 `Connector | undefined`
 
-[Connector](/core/connectors) to disconnect with.
+[Connector](/core/api/connectors) to disconnect with.
 
 ::: code-group
 ```ts [index.ts]

diff --git a/docs/core/actions/estimateFeesPerGas.md → docs/core/api/actions/estimateFeesPerGas.md b/docs/core/actions/estimateFeesPerGas.md → docs/core/api/actions/estimateFeesPerGas.md
diff --git a/docs/core/actions/getAccount.md → docs/core/api/actions/getAccount.md b/docs/core/actions/getAccount.md → docs/core/api/actions/getAccount.md
diff --git a/docs/core/actions/getBalance.md → docs/core/api/actions/getBalance.md b/docs/core/actions/getBalance.md → docs/core/api/actions/getBalance.md
diff --git a/docs/core/actions/getBlockNumber.md → docs/core/api/actions/getBlockNumber.md b/docs/core/actions/getBlockNumber.md → docs/core/api/actions/getBlockNumber.md
diff --git a/docs/core/actions/getChainId.md → docs/core/api/actions/getChainId.md b/docs/core/actions/getChainId.md → docs/core/api/actions/getChainId.md
diff --git a/docs/core/actions/getConnections.md → docs/core/api/actions/getConnections.md b/docs/core/actions/getConnections.md → docs/core/api/actions/getConnections.md
diff --git a/docs/core/actions/getConnectorClient.md → docs/core/api/actions/getConnectorClient.md b/docs/core/actions/getConnectorClient.md → docs/core/api/actions/getConnectorClient.md
diff --git a/docs/core/actions/getEnsAddress.md → docs/core/api/actions/getEnsAddress.md b/docs/core/actions/getEnsAddress.md → docs/core/api/actions/getEnsAddress.md
diff --git a/docs/core/actions/getEnsAvatar.md → docs/core/api/actions/getEnsAvatar.md b/docs/core/actions/getEnsAvatar.md → docs/core/api/actions/getEnsAvatar.md
diff --git a/docs/core/actions/getEnsName.md → docs/core/api/actions/getEnsName.md b/docs/core/actions/getEnsName.md → docs/core/api/actions/getEnsName.md
diff --git a/docs/core/actions/getEnsResolver.md → docs/core/api/actions/getEnsResolver.md b/docs/core/actions/getEnsResolver.md → docs/core/api/actions/getEnsResolver.md
diff --git a/docs/core/actions/getToken.md → docs/core/api/actions/getToken.md b/docs/core/actions/getToken.md → docs/core/api/actions/getToken.md
diff --git a/docs/core/actions/getTransaction.md → docs/core/api/actions/getTransaction.md b/docs/core/actions/getTransaction.md → docs/core/api/actions/getTransaction.md
diff --git a/docs/core/actions/multicall.md → docs/core/api/actions/multicall.md b/docs/core/actions/multicall.md → docs/core/api/actions/multicall.md
diff --git a/docs/core/actions/readContract.md → docs/core/api/actions/readContract.md b/docs/core/actions/readContract.md → docs/core/api/actions/readContract.md
diff --git a/docs/core/actions/readContracts.md → docs/core/api/actions/readContracts.md b/docs/core/actions/readContracts.md → docs/core/api/actions/readContracts.md
diff --git a/docs/core/actions/reconnect.md → docs/core/api/actions/reconnect.md b/docs/core/actions/reconnect.md → docs/core/api/actions/reconnect.md
@@ -6,7 +6,7 @@ const typeName = 'Reconnect'
 
 # reconnect
 
-Action for reconnecting [connectors](/core/connectors).
+Action for reconnecting [connectors](/core/api/connectors).
 
 ## Import
 
@@ -37,7 +37,7 @@ import { type ReconnectParameters } from '@wagmi/core'
 
 `(CreateConnectorFn | Connector)[] | undefined`
 
-- [Connectors](/core/connectors) to reconnect to.
+- [Connectors](/core/api/connectors) to reconnect to.
 - Defaults to [`Config['connectors']`](/core/createConfig#connectors).
 
 ::: code-group

diff --git a/docs/core/actions/sendTransaction.md → docs/core/api/actions/sendTransaction.md b/docs/core/actions/sendTransaction.md → docs/core/api/actions/sendTransaction.md
diff --git a/docs/core/actions/signMessage.md → docs/core/api/actions/signMessage.md b/docs/core/actions/signMessage.md → docs/core/api/actions/signMessage.md
@@ -55,7 +55,7 @@ const result = await signMessage(config, {
 
 `Connector | undefined`
 
-[Connector](/core/connectors) to sign message with.
+[Connector](/core/api/connectors) to sign message with.
 
 ::: code-group
 ```ts [index.ts]

diff --git a/docs/core/actions/signTypedData.md → docs/core/api/actions/signTypedData.md b/docs/core/actions/signTypedData.md → docs/core/api/actions/signTypedData.md
@@ -93,7 +93,7 @@ const result = await signTypedData(config, {
 
 `Connector | undefined`
 
-[Connector](/core/connectors) to sign data with.
+[Connector](/core/api/connectors) to sign data with.
 
 ::: code-group
 ```ts [index.ts]

diff --git a/docs/core/actions/simulateContract.md → docs/core/api/actions/simulateContract.md b/docs/core/actions/simulateContract.md → docs/core/api/actions/simulateContract.md
diff --git a/docs/core/actions/switchAccount.md → docs/core/api/actions/switchAccount.md b/docs/core/actions/switchAccount.md → docs/core/api/actions/switchAccount.md
@@ -39,7 +39,7 @@ import { type SwitchAccountParameters } from '@wagmi/core'
 
 `Connector`
 
-[Connector](/core/connectors) to switch to.
+[Connector](/core/api/connectors) to switch to.
 
 ::: code-group
 ```ts [index.ts]

diff --git a/docs/core/actions/switchChain.md → docs/core/api/actions/switchChain.md b/docs/core/actions/switchChain.md → docs/core/api/actions/switchChain.md
@@ -60,7 +60,7 @@ const result = await switchChain(config, {
 
 `Connector`
 
-[Connector](/core/connectors) to switch chain with.
+[Connector](/core/api/connectors) to switch chain with.
 
 ::: code-group
 ```ts [index.ts]

diff --git a/docs/core/actions/watchAccount.md → docs/core/api/actions/watchAccount.md b/docs/core/actions/watchAccount.md → docs/core/api/actions/watchAccount.md
diff --git a/docs/core/actions/watchChainId.md → docs/core/api/actions/watchChainId.md b/docs/core/actions/watchChainId.md → docs/core/api/actions/watchChainId.md
diff --git a/docs/core/actions/watchConnections.md → docs/core/api/actions/watchConnections.md b/docs/core/actions/watchConnections.md → docs/core/api/actions/watchConnections.md
diff --git a/docs/core/chains.md → docs/core/api/chains.md b/docs/core/chains.md → docs/core/api/chains.md
diff --git a/docs/core/connectors.md → docs/core/api/connectors.md b/docs/core/connectors.md → docs/core/api/connectors.md
diff --git a/docs/core/connectors/coinbaseWallet.md → docs/core/api/connectors/coinbaseWallet.md b/docs/core/connectors/coinbaseWallet.md → docs/core/api/connectors/coinbaseWallet.md
diff --git a/docs/core/connectors/injected.md → docs/core/api/connectors/injected.md b/docs/core/connectors/injected.md → docs/core/api/connectors/injected.md
diff --git a/docs/core/createConfig.md → docs/core/api/createConfig.md b/docs/core/createConfig.md → docs/core/api/createConfig.md
diff --git a/docs/core/createConnector.md → docs/core/api/createConnector.md b/docs/core/createConnector.md → docs/core/api/createConnector.md
diff --git a/docs/core/createStorage.md → docs/core/api/createStorage.md b/docs/core/createStorage.md → docs/core/api/createStorage.md
diff --git a/docs/core/errors.md → docs/core/api/errors.md b/docs/core/errors.md → docs/core/api/errors.md
diff --git a/docs/core/utilities/deserialize.md → docs/core/api/utilities/deserialize.md b/docs/core/utilities/deserialize.md → docs/core/api/utilities/deserialize.md
diff --git a/docs/core/utilities/normalizeChainId.md → docs/core/api/utilities/normalizeChainId.md b/docs/core/utilities/normalizeChainId.md → docs/core/api/utilities/normalizeChainId.md
diff --git a/docs/core/utilities/serialize.md → docs/core/api/utilities/serialize.md b/docs/core/utilities/serialize.md → docs/core/api/utilities/serialize.md
diff --git a/docs/core/getting-started.md b/docs/core/getting-started.md
@@ -22,7 +22,7 @@ yarn add @wagmi/core @wagmi/connectors viem
 ```
 :::
 
-- [Wagmi Connectors](/core/connectors) is a collection of interfaces for linking accounts/wallets to Wagmi.
+- [Wagmi Connectors](/core/api/connectors) is a collection of interfaces for linking accounts/wallets to Wagmi.
 - [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
 - [TypeScript](/react/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/core/typescript).
 

diff --git a/docs/core/faq.md → docs/core/guides/faq.md b/docs/core/faq.md → docs/core/guides/faq.md
diff --git a/docs/core/testing.md → docs/core/guides/testing.md b/docs/core/testing.md → docs/core/guides/testing.md
diff --git a/docs/core/typescript.md b/docs/core/typescript.md
@@ -53,7 +53,7 @@ Unfortunately [TypeScript doesn't support importing JSON `as const` yet](https:/
 
 Anywhere you see the `abi` or `types` configuration property, you can likely use const-asserted or inline ABIs and Typed Data to get type-safety and inference. These properties are also called out in the docs.
 
-Here's what [`readContract`](/core/actions/readContract) looks like with and without a const-asserted `abi` property.
+Here's what [`readContract`](/core/api/actions/readContract) looks like with and without a const-asserted `abi` property.
 
 ::: code-group
 ```ts twoslash [Const-Asserted]

diff --git a/docs/index.md b/docs/index.md
@@ -24,7 +24,7 @@ features:
   - icon: 🚀
     title: 20+ React Hooks
     details: React Hooks for accounts, wallets, contracts, transactions, signing, ENS, and more.
-    link: /react/hooks
+    link: /react/api/hooks
     linkText: See all hooks
   - icon: 🦄
     title: TypeScript Ready
@@ -34,7 +34,7 @@ features:
   - icon: 💼
     title: Connect Wallet
     details: Official wallet connectors for MetaMask, WalletConnect, Coinbase Wallet, and more.
-    link: /react/connectors
+    link: /react/api/connectors
     linkText: See all connectors
   - icon: 👟
     title: Caching, Deduplication & Persistence

diff --git a/docs/react/WagmiProvider.md → docs/react/api/WagmiProvider.md b/docs/react/WagmiProvider.md → docs/react/api/WagmiProvider.md
diff --git a/docs/react/actions.md → docs/react/api/actions.md b/docs/react/actions.md → docs/react/api/actions.md
@@ -25,4 +25,4 @@ function App() {
 <<< @/snippets/react/config.ts[config.ts]
 :::
 
-See the [Wagmi Core docs](/core/actions) for more info on what actions are available.
+See the [Wagmi Core docs](/core/api/actions) for more info on what actions are available.
diff --git a/docs/react/chains.md → docs/react/api/chains.md b/docs/react/chains.md → docs/react/api/chains.md
diff --git a/docs/react/connectors.md → docs/react/api/connectors.md b/docs/react/connectors.md → docs/react/api/connectors.md
@@ -1,9 +1,9 @@
 <script setup>
-import { getSidebar } from '../.vitepress/sidebar'
+import { getSidebar } from '../../.vitepress/sidebar'
 
 const connectors = getSidebar()['/react']
   .find(x => x.text === 'API').items
-  .find(x => x.link === '/react/connectors').items
+  .find(x => x.link === '/react/api/connectors').items
   .sort((a, b) => a.text.localeCompare(b.text))
 </script>
 

diff --git a/docs/react/connectors/coinbaseWallet.md → docs/react/api/connectors/coinbaseWallet.md b/docs/react/connectors/coinbaseWallet.md → docs/react/api/connectors/coinbaseWallet.md
diff --git a/docs/react/connectors/injected.md → docs/react/api/connectors/injected.md b/docs/react/connectors/injected.md → docs/react/api/connectors/injected.md
diff --git a/docs/react/createConfig.md → docs/react/api/createConfig.md b/docs/react/createConfig.md → docs/react/api/createConfig.md
diff --git a/docs/react/createStorage.md → docs/react/api/createStorage.md b/docs/react/createStorage.md → docs/react/api/createStorage.md
diff --git a/docs/react/errors.md → docs/react/api/errors.md b/docs/react/errors.md → docs/react/api/errors.md
diff --git a/docs/react/hooks.md → docs/react/api/hooks.md b/docs/react/hooks.md → docs/react/api/hooks.md
@@ -1,9 +1,9 @@
 <script setup>
-import { getSidebar } from '../.vitepress/sidebar'
+import { getSidebar } from '../../.vitepress/sidebar'
 
 const hooks = getSidebar()['/react']
   .find(x => x.text === 'API').items
-  .find(x => x.link === '/react/hooks').items
+  .find(x => x.link === '/react/api/hooks').items
   .sort((a, b) => a.text.localeCompare(b.text))
 </script>
 

diff --git a/docs/react/hooks/useAccount.md → docs/react/api/hooks/useAccount.md b/docs/react/hooks/useAccount.md → docs/react/api/hooks/useAccount.md
@@ -65,5 +65,5 @@ import { type UseAccountReturnType } from 'wagmi'
 
 ## Action
 
-- [`getAccount`](/core/actions/getAccount)
-- [`watchAccount`](/core/actions/getAccount#watchaccount)
+- [`getAccount`](/core/api/actions/getAccount)
+- [`watchAccount`](/core/api/actions/watchAccount)
diff --git a/docs/react/hooks/useBalance.md → docs/react/api/hooks/useBalance.md b/docs/react/hooks/useBalance.md → docs/react/api/hooks/useBalance.md
@@ -199,4 +199,4 @@ import { type UseBalanceReturnType } from 'wagmi'
 
 ## Action
 
-[getBalance](/core/actions/getBalance)
+[getBalance](/core/api/actions/getBalance)
diff --git a/docs/react/hooks/useBlockNumber.md → docs/react/api/hooks/useBlockNumber.md b/docs/react/hooks/useBlockNumber.md → docs/react/api/hooks/useBlockNumber.md
@@ -99,7 +99,7 @@ function App() {
 `boolean | UseWatchBlockNumberParameters | undefined`
 
 - Enables/disables listening for block number changes.
-- Can pass a subset of [`UseWatchBlockNumberParameters`](/react/hooks/useWatchBlockNumber#parameters)directly to [`useWatchBlockNumber`](/react/hooks/useWatchBlockNumber).
+- Can pass a subset of [`UseWatchBlockNumberParameters`](/react/api/hooks/useWatchBlockNumber#parameters)directly to [`useWatchBlockNumber`](/react/api/hooks/useWatchBlockNumber).
 
 ::: code-group
 ```tsx [index.tsx]
@@ -139,5 +139,5 @@ import { type UseBlockNumberReturnType } from 'wagmi'
 
 ## Action
 
-- [getBlockNumber](/core/actions/getBlockNumber)
-- [watchBlockNumber](/core/actions/getBlockNumber#watchblocknumber)
+- [getBlockNumber](/core/api/actions/getBlockNumber)
+- [watchBlockNumber](/core/api/actions/watchBlockNumber)
diff --git a/docs/react/hooks/useChainId.md → docs/react/api/hooks/useChainId.md b/docs/react/hooks/useChainId.md → docs/react/api/hooks/useChainId.md
@@ -59,5 +59,5 @@ Current chain ID from [`config.state.chainId`](/react/createConfig#chainid).
 
 ## Action
 
-- [`getChainId`](/core/actions/getChainId)
-- [`watchChainId`](/core/actions/getChainId#watchchainid)
+- [`getChainId`](/core/api/actions/getChainId)
+- [`watchChainId`](/core/api/actions/watchChainId)
diff --git a/docs/react/hooks/useConfig.md → docs/react/api/hooks/useConfig.md b/docs/react/hooks/useConfig.md → docs/react/api/hooks/useConfig.md
diff --git a/docs/react/hooks/useConnect.md → docs/react/api/hooks/useConnect.md b/docs/react/hooks/useConnect.md → docs/react/api/hooks/useConnect.md
@@ -10,7 +10,7 @@ const TVariables = '{ chainId?: number | undefined; connector?: CreateConnectorF
 
 # useConnect
 
-Hook for connecting accounts with [connectors](/react/connectors).
+Hook for connecting accounts with [connectors](/react/api/connectors).
 
 ## Import
 
@@ -110,4 +110,4 @@ Not all connectors support connecting directly to a `chainId` (e.g. they don't s
 
 ## Action
 
-[`connect`](/core/actions/connect)
+[`connect`](/core/api/actions/connect)
diff --git a/docs/react/hooks/useConnections.md → docs/react/api/hooks/useConnections.md b/docs/react/hooks/useConnections.md → docs/react/api/hooks/useConnections.md
@@ -55,5 +55,5 @@ import { type UseConnectionsReturnType } from 'wagmi'
 
 ## Action
 
-- [`getConnections`](/core/actions/getConnections)
-- [`watchConnections`](/core/actions/getConnections#watchconnections)
+- [`getConnections`](/core/api/actions/getConnections)
+- [`watchConnections`](/core/api/actions/watchConnections)
diff --git a/docs/react/hooks/useDisconnect.md → docs/react/api/hooks/useDisconnect.md b/docs/react/hooks/useDisconnect.md → docs/react/api/hooks/useDisconnect.md
@@ -105,4 +105,4 @@ function App() {
 
 ## Actions
 
-[`disconnect`](/core/actions/connect)
+[`disconnect`](/core/api/actions/connect)
diff --git a/docs/react/hooks/useEnsAddress.md → docs/react/api/hooks/useEnsAddress.md b/docs/react/hooks/useEnsAddress.md → docs/react/api/hooks/useEnsAddress.md
@@ -209,4 +209,4 @@ import { type UseEnsAddressReturnType } from 'wagmi'
 
 ## Action
 
-[getEnsAddress](/core/actions/getEnsAddress)
+[getEnsAddress](/core/api/actions/getEnsAddress)
diff --git a/docs/react/hooks/useEnsAvatar.md → docs/react/api/hooks/useEnsAvatar.md b/docs/react/hooks/useEnsAvatar.md → docs/react/api/hooks/useEnsAvatar.md
@@ -211,4 +211,4 @@ import { type UseEnsAvatarReturnType } from 'wagmi'
 
 ## Action
 
-[getEnsAvatar](/core/actions/getEnsAvatar)
+[getEnsAvatar](/core/api/actions/getEnsAvatar)
diff --git a/docs/react/hooks/useEnsName.md → docs/react/api/hooks/useEnsName.md b/docs/react/hooks/useEnsName.md → docs/react/api/hooks/useEnsName.md
@@ -178,4 +178,4 @@ import { type UseEnsNameReturnType } from 'wagmi'
 
 ## Action
 
-[getEnsName](/core/actions/getEnsName)
+[getEnsName](/core/api/actions/getEnsName)
diff --git a/docs/react/hooks/useEnsResolver.md → docs/react/api/hooks/useEnsResolver.md b/docs/react/hooks/useEnsResolver.md → docs/react/api/hooks/useEnsResolver.md
@@ -188,4 +188,4 @@ import { type UseEnsResolverReturnType } from 'wagmi'
 
 ## Action
 
-[getEnsResolver](/core/actions/getEnsResolver)
+[getEnsResolver](/core/api/actions/getEnsResolver)
diff --git a/docs/react/hooks/useEstimateFeesPerGas.md → .../react/api/hooks/useEstimateFeesPerGas.md b/docs/react/hooks/useEstimateFeesPerGas.md → .../react/api/hooks/useEstimateFeesPerGas.md
@@ -138,4 +138,4 @@ import { type UseEstimateFeesPerGasReturnType } from 'wagmi'
 
 ## Action
 
-[estimateFeesPerGas](/core/actions/estimateFeesPerGas)
+[estimateFeesPerGas](/core/api/actions/estimateFeesPerGas)
diff --git a/docs/react/hooks/useReconnect.md → docs/react/api/hooks/useReconnect.md b/docs/react/hooks/useReconnect.md → docs/react/api/hooks/useReconnect.md
@@ -10,7 +10,7 @@ const TVariables = '{ connectors?: (CreateConnectorFn | Connector)[] | undefined
 
 # useReconnect
 
-Hook for reconnecting [connectors](/core/connectors).
+Hook for reconnecting [connectors](/core/api/connectors).
 
 ## Import
 
@@ -102,4 +102,4 @@ function App() {
 
 ## Action
 
-[`reconnect`](/core/actions/reconnect)
+[`reconnect`](/core/api/actions/reconnect)
diff --git a/docs/react/hooks/useSwitchAccount.md → docs/react/api/hooks/useSwitchAccount.md b/docs/react/hooks/useSwitchAccount.md → docs/react/api/hooks/useSwitchAccount.md
@@ -1,6 +1,6 @@
 # useSwitchAccount
 
-Hook for switching accounts with [connectors](/core/connectors).
+Hook for switching accounts with [connectors](/core/api/connectors).
 
 ## Import
 

diff --git a/docs/react/hooks/useToken.md → docs/react/api/hooks/useToken.md b/docs/react/hooks/useToken.md → docs/react/api/hooks/useToken.md
@@ -135,4 +135,4 @@ import { type UseTokenReturnType } from 'wagmi'
 
 ## Action
 
-[getToken](/core/actions/getToken)
+[getToken](/core/api/actions/getToken)
diff --git a/docs/react/utilities/deserialize.md → docs/react/api/utilities/deserialize.md b/docs/react/utilities/deserialize.md → docs/react/api/utilities/deserialize.md
diff --git a/docs/react/utilities/normalizeChainId.md → docs/react/api/utilities/normalizeChainId.md b/docs/react/utilities/normalizeChainId.md → docs/react/api/utilities/normalizeChainId.md
diff --git a/docs/react/utilities/serialize.md → docs/react/api/utilities/serialize.md b/docs/react/utilities/serialize.md → docs/react/api/utilities/serialize.md
diff --git a/docs/react/faq.md → docs/react/guides/faq.md b/docs/react/faq.md → docs/react/guides/faq.md
diff --git a/docs/react/tanstack-query.md → docs/react/guides/tanstack-query.md b/docs/react/tanstack-query.md → docs/react/guides/tanstack-query.md
diff --git a/docs/react/migration-guide.md b/docs/react/migration-guide.md