Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch: Fix docs build #1712

Merged
merged 10 commits into from
May 12, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
},
"type": "module",
"dependencies": {
"@sveltejs/adapter-static": "^2.0.2",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be a devDep and we can remove the adapter-auto

"@web3-onboard/cede-store": "^2.0.1",
"@web3-onboard/coinbase": "^2.2.3",
"@web3-onboard/core": "^2.18.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand All @@ -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**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
4 changes: 0 additions & 4 deletions docs/src/routes/docs/[...3]modules/[...1]core/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/routes/docs/[...3]modules/[...3]react/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ const [

This hook allows the dev to access all notifications if enabled, send custom notifications and update notify <enable/disable & update transactionHandler function>
**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 = (): [
Expand Down
2 changes: 1 addition & 1 deletion docs/svelte.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import adapter from '@sveltejs/adapter-auto'
import adapter from '@sveltejs/adapter-static';
leightkt marked this conversation as resolved.
Show resolved Hide resolved
import preprocess from 'svelte-preprocess'

/** @type {import('@sveltejs/kit').Config} */
Expand Down
29 changes: 17 additions & 12 deletions docs/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3325,6 +3325,11 @@
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"
resolved "https://registry.yarnpkg.com/@sveltejs/kit/-/kit-1.16.3.tgz#2b7540dbe08ce5d2eb46a282043c5a345f25691e"
Expand Down Expand Up @@ -3810,9 +3815,9 @@
integrity sha512-iiUgKzV9AuaEkZqkOLDIvlQiL6ltuZd9tGcW3gwpnX8JbuiuhFlEGmmFXEXkN50Cvq7Os88IY2v0dkDqXYWVgA==

"@types/node@*", "@types/node@>=13.7.0":
version "20.1.2"
resolved "https://registry.yarnpkg.com/@types/node/-/node-20.1.2.tgz#8fd63447e3f99aba6c3168fd2ec4580d5b97886f"
integrity sha512-CTO/wa8x+rZU626cL2BlbCDzydgnFNgc19h4YvizpTO88MFQxab8wqisxaofQJ/9bLGugRdWIuX/TbIs6VVF6g==
version "20.1.3"
resolved "https://registry.yarnpkg.com/@types/node/-/node-20.1.3.tgz#bc8e7cd8065a5fc355a3a191a68db8019c58bc00"
integrity sha512-NP2yfZpgmf2eDRPmgGq+fjGjSwFgYbihA8/gK+ey23qT9RkxsgNTZvGOEpXgzIGqesTYkElELLgtKoMQTys5vA==

"@types/node@10.12.18":
version "10.12.18"
Expand Down Expand Up @@ -6612,9 +6617,9 @@ eip55@^2.1.0:
keccak "^1.3.0"

electron-to-chromium@^1.4.284:
version "1.4.391"
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.391.tgz#197994210792e29e39baf3ce807df42f66e9b5f8"
integrity sha512-GqydVV1+kUWY5qlEzaw34/hyWTApuQrHiGrcGA2Kk/56nEK44i+YUW45VH43JuZT0Oo7uY8aVtpPhBBZXEWtSA==
version "1.4.393"
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.393.tgz#82a2dcd50dc7ea392d5875e10be81c3667ff8133"
integrity sha512-Yl1E9pu+7PBKSVHZsuw79QVa8ZonpyxBGI/MnuBumiXpxNuNwFo9iZLAAhQGla/LTAt1A7zR4PwgysukxJc0qA==

elliptic@6.5.4, elliptic@^6.0.0, elliptic@^6.4.0, elliptic@^6.4.1, elliptic@^6.5.2, elliptic@^6.5.3, elliptic@^6.5.4:
version "6.5.4"
Expand Down Expand Up @@ -8911,9 +8916,9 @@ lit-element@^3.2.0:
lit-html "^2.7.0"

lit-html@^2.6.0, lit-html@^2.7.0:
version "2.7.3"
resolved "https://registry.yarnpkg.com/lit-html/-/lit-html-2.7.3.tgz#903bfa61f9d3296a0ec94128695e452beb9b1a3a"
integrity sha512-9DyLzcn/kbRGowz2vFmSANFbRZTxYUgYYFqzie89w6GLpPUiBCDHfcdeRUV/k3Q2ueYxNjfv46yPCtKAEAPOVw==
version "2.7.4"
resolved "https://registry.yarnpkg.com/lit-html/-/lit-html-2.7.4.tgz#6d75001977c206683685b9d76594a516afda2954"
integrity sha512-/Jw+FBpeEN+z8X6PJva5n7+0MzCVAH2yypN99qHYYkq8bI+j7I39GH+68Z/MZD6rGKDK9RpzBw7CocfmHfq6+g==
dependencies:
"@types/trusted-types" "^2.0.2"

Expand Down Expand Up @@ -11312,9 +11317,9 @@ semver@^6.1.1, semver@^6.1.2, semver@^6.3.0:
integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==

semver@^7.3.8:
version "7.5.0"
resolved "https://registry.yarnpkg.com/semver/-/semver-7.5.0.tgz#ed8c5dc8efb6c629c88b23d41dc9bf40c1d96cd0"
integrity sha512-+XC0AD/R7Q2mPSRuy2Id0+CGTZ98+8f+KvwirxOKIEyid+XSx6HbC63p+O4IndTHuX5Z+JxQ0TghCkO5Cg/2HA==
version "7.5.1"
resolved "https://registry.yarnpkg.com/semver/-/semver-7.5.1.tgz#c90c4d631cf74720e46b21c1d37ea07edfab91ec"
integrity sha512-Wvss5ivl8TMRZXXESstBA4uR5iXgEN/VC5/sOcuXdVLzcdkz4HWetIoRfG5gb5X+ij/G9rw9YoGn3QoQ8OCSpw==
dependencies:
lru-cache "^6.0.0"

Expand Down