diff --git a/docs/package.json b/docs/package.json index 44b1e46f9..3cbd75db1 100644 --- a/docs/package.json +++ b/docs/package.json @@ -20,7 +20,7 @@ "@docsearch/css": "^3.3.3", "@docsearch/js": "^3.3.3", "@iconify-json/ri": "^1.0.0", - "@sveltejs/adapter-auto": "^2.0.0", + "@sveltejs/adapter-static": "^2.0.2", "@sveltejs/kit": "^1.5.0", "@svelteness/kit-docs": "^1.1.3", "@tailwindcss/typography": "^0.5.9", diff --git a/docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md b/docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md index 67cb56c6a..bc0499cfd 100644 --- a/docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md +++ b/docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md @@ -33,7 +33,7 @@ Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain ### Supported Networks -web3-onboard supports all EVM networks. Supporting a new network is simply a matter of adding its details in the Chains section upon initialization. For more information see [initialization options](../../modules/core.md#options). +web3-onboard supports all EVM networks. Supporting a new network is simply a matter of adding its details in the Chains section upon initialization. For more information see [initialization options](../../modules/core.md#initialization). - Ethereum - Polygon @@ -140,7 +140,7 @@ if (wallets[0]) { Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your web3-onboard implementation. All modules are listed below and can be accessed through the subpages of web3-onboard docs on the left. -We recommend you add the [Core Repo](../..modules/core.md#install) and consider adding the [Injected Wallets](../../wallets/injected.md#install) module to get connected with wallets like Metamask, Trust, Coinbase Wallet & more right away. +We recommend you add the [Core Repo](../../modules/core.md#install) and consider adding the [Injected Wallets](../../wallets/injected.md#install) module to get connected with wallets like Metamask, Trust, Coinbase Wallet & more right away. [**Core Repo**](../../modules/core.md#install) @@ -152,11 +152,11 @@ We recommend you add the [Core Repo](../..modules/core.md#install) and consider - [WalletConnect](../../wallets/walletconnect.md#install) - [Gnosis](../../wallets/gnosis.md#install) - [Magic](../../wallets/magic.md#login-options) -- [Fortmatic](../../wallets/formatic.md#install) +- [Fortmatic](../../wallets/fortmatic.md#install) - [MEW](../../wallets/mewwallet.md#install) - [Portis](../../wallets/portis.md#install) - [Web3Auth](../../wallets/web3auth.md#install) -- [Frame](../../docs/wallets/frame.md#install) +- [Frame](../../wallets/frame.md#install) **Hardware Wallets** diff --git a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md index 2b76e0076..e95b2f374 100644 --- a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md +++ b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md @@ -19,7 +19,7 @@ If an issue does not already exist, follow the template instructions to create a Once an issue is created, a Web3 Onboard maintainer will review and respond typically within a few days to share next steps. -## [Pull Requests 🗂️](#pr) +## [Pull Requests 🗂️] To create a new feature or change in Web3 Onboard, fork the repo and make a pull request on the [develop branch](https://github.com/blocknative/web3-onboard/tree/develop) to have your changes merged in and released as part of the official packages. @@ -39,7 +39,7 @@ Example : Adding a new injected wallet to the `injected` package - Example 2 : Bug fix within the `core` package - [Core package.json](https://github.com/blocknative/web3-onboard/blob/8531a73d69365f7d584320f1c4b97a5d90f1c34e/packages/core/package.json#L3) changes: `"version": "2.9.1-alpha.1",` --> `"version": "2.9.1-alpha.2",` -## [How can I add a new wallet? 💳](#new-wallet) +## [How can I add a new wallet? 💳] To add a new wallet to the official Web3 Onboard packages and repo, create a [pull request](#pull-requests-🗂️). Web3 Onboard does not require a wallet to be a part of the main code, so a separate wallet module can be created without any changes to the Web3Onboard codebase. Your PR must include a detailed README for the package, keeping in mind that this README is the the first point of contact for dapp devs looking to implement your wallet. @@ -57,7 +57,7 @@ Otherwise, if the wallet you are adding requires dependencies and initialization If you cannot write the code yourself to add a new wallet, create a new feature request issue to be considered by the maintainers and other contributors in the community. -## [Documentation Contributions 📄](#docs) +## [Documentation Contributions 📄] If you contribute to the code, you should definitely document appropriately. @@ -71,11 +71,11 @@ PRs for adding/updating a wallet should include a README (new or updated) for th We highly encourage the community to help us improve the web3-onboard docs! If you have any questions don't hesitate to reach out. -## [Feedback 💬](#feedback) +## [Feedback 💬] Did you have trouble integrating? Could the docs be improved? Have a new Feature request? Jump in our [Discord](https://discord.com/invite/KZaBVME) and share your feedback. -## [Support 🤓](#support) +## [Support 🤓] For general questions about how to use Web3 Onboard please first check out our [docs](../../overview/introduction.md#features), then head to our [Discord](https://discord.com/invite/KZaBVME) for support from the Blocknative team. diff --git a/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md b/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md index 3b1eb54fe..7c914e84e 100644 --- a/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md +++ b/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md @@ -47,7 +47,7 @@ const onboard = Onboard({ }) ``` -You can find the full list of initialization options in our docs [here](/docs/modules/core#options). +You can find the full list of initialization options in our docs [here](/docs/modules/core#initialization). ### API Upgrades diff --git a/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md b/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md index 18ac43f7e..956587cd2 100644 --- a/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md +++ b/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md @@ -73,7 +73,7 @@ const chains = [ #### App Metadata (Optional) You can add metadata about your dapp. -A full definition of `appMetaData` options can be found [here](/docs/modules/core#options) +A full definition of `appMetaData` options can be found [here](/docs/modules/core#initialization) ```ts const appMetadata = { diff --git a/docs/src/routes/docs/[...3]modules/[...1]core/+page.md b/docs/src/routes/docs/[...3]modules/[...1]core/+page.md index b823c4b14..dcd637d50 100644 --- a/docs/src/routes/docs/[...3]modules/[...1]core/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...1]core/+page.md @@ -145,11 +145,7 @@ type Chain = { icon?: string // the icon to represent the chain publicRpcUrl?: string // an optional public RPC used when adding a new chain config to the wallet blockExplorerUrl?: string // also used when adding a new config to the wallet -<<<<<<< HEAD:docs/src/routes/docs/[...3]modules/[...1]core/+page.md secondaryTokens?: SecondaryTokens[] // An optional array of tokens (max of 5) to be available to the dapp in the app state object per wallet within the wallet account and displayed in Account Center (if enabled) -======= - secondaryTokens?: SecondaryTokens[] // An optional array of tokens (max of 5) to be available to the dapp in the app state object per wallet within the wallet account and displayed in Account Center (if enabled) ->>>>>>> develop:docs/src/routes/docs/[...3]modules/core.md } interface SecondaryTokens { diff --git a/docs/src/routes/docs/[...3]modules/[...3]react/+page.md b/docs/src/routes/docs/[...3]modules/[...3]react/+page.md index cf22d1ccf..2e1067bd8 100644 --- a/docs/src/routes/docs/[...3]modules/[...3]react/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...3]react/+page.md @@ -228,7 +228,7 @@ const [ This hook allows the dev to access all notifications if enabled, send custom notifications and update notify **note** requires an API key be added to the initialization, enabled by default if API key exists -For full Notification documentation please see [Notify section within the `@web3-onboard/core` docs](../../modules/core.md#options) +For full Notification documentation please see [Notify section within the `@web3-onboard/core` docs](../../modules/core.md#initialization) ```typescript type UseNotifications = (): [ diff --git a/docs/svelte.config.js b/docs/svelte.config.js index c2695fbf0..0387d9897 100644 --- a/docs/svelte.config.js +++ b/docs/svelte.config.js @@ -1,4 +1,4 @@ -import adapter from '@sveltejs/adapter-auto' +import adapter from '@sveltejs/adapter-static' import preprocess from 'svelte-preprocess' /** @type {import('@sveltejs/kit').Config} */ diff --git a/docs/yarn.lock b/docs/yarn.lock index 3130361b9..4ad550dca 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -3318,12 +3318,10 @@ "@stablelib/random" "^1.0.2" "@stablelib/wipe" "^1.0.1" -"@sveltejs/adapter-auto@^2.0.0": - version "2.0.1" - resolved "https://registry.yarnpkg.com/@sveltejs/adapter-auto/-/adapter-auto-2.0.1.tgz#86b14efd833d7002e4ab2338d5c1efaddb8729d3" - integrity sha512-anxxYMcQy7HWSKxN4YNaVcgNzCHtNFwygq72EA1Xv7c+5gSECOJ1ez1PYoLciPiFa7A3XBvMDQXUFJ2eqLDtAA== - dependencies: - import-meta-resolve "^3.0.0" +"@sveltejs/adapter-static@^2.0.2": + version "2.0.2" + resolved "https://registry.yarnpkg.com/@sveltejs/adapter-static/-/adapter-static-2.0.2.tgz#49afd27787fb73d789017d002a91031088494139" + integrity sha512-9wYtf6s6ew7DHUHMrt55YpD1FgV7oWql2IGsW5BXquLxqcY9vjrqCFo0TzzDpo+ZPZkW/v77k0eOP6tsAb8HmQ== "@sveltejs/kit@^1.5.0": version "1.16.3" @@ -8085,11 +8083,6 @@ import-fresh@^3.2.1: parent-module "^1.0.0" resolve-from "^4.0.0" -import-meta-resolve@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/import-meta-resolve/-/import-meta-resolve-3.0.0.tgz#94a6aabc623874fbc2f3525ec1300db71c6cbc11" - integrity sha512-4IwhLhNNA8yy445rPjD/lWh++7hMDOml2eHtd58eG7h+qK3EryMuuRbsHGPikCoAgIkkDnckKfWSk2iDla/ejg== - imurmurhash@^0.1.4: version "0.1.4" resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"