Skip to content

Commit 4c4056c

Browse files
Update Doc Language & Links (#2191)
Updated spelling, capitalization, and some missing links.
1 parent 0184045 commit 4c4056c

File tree

46 files changed

+194
-166
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+194
-166
lines changed

docs/src/lib/components/FeaturesSection.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@
4848
/>
4949
<FeatureCard
5050
title={'Dynamic Imports'}
51-
text={"Supporting multiple wallets in your app requires a lot of dependencies. Onboard dynamically imports a wallet and it's dependencies only when the user selects it, so that minimal bandwidth is used."}
51+
text={"Supporting multiple wallets in your app requires a lot of dependencies. Web3 Onboard dynamically imports a wallet and it's dependencies only when the user selects it, so that minimal bandwidth is used."}
5252
/>
5353
<FeatureCard
5454
title={'Wallet Provider Standardization'}
55-
text={'All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085 and EIP-3326 specifications.'}
55+
text={'All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085, EIP-3326, and EIP-6963 specifications.'}
5656
/>
5757
<FeatureCard
5858
title={'Multiple Chain Support'}

docs/src/routes/+page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ yarn add @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/transac
9090

9191
## Installation
9292

93-
Install the core Onboard library and the injected wallets module to support browser extension and mobile wallets:
93+
Install the core Web3 Onboard library and the injected wallets module to support browser extension and mobile wallets:
9494

9595
```bash copy
9696
npm i @web3-onboard/core @web3-onboard/injected-wallets

docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The best way to connect a wallet 🚀
1212

1313
<img src="{walletModal}" alt="Web3-Onboard connect wallet modal"/>
1414

15-
Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain support to your project. With built-in modules for more than 35 unique hardware and software wallets, Web3-Onboard saves you time and headaches.
15+
Web3 Onboard is the quickest and easiest way to add multi-wallet and multi-chain support to your project. With built-in modules for more than 80 unique hardware and software wallets, Web3 Onboard saves you time and headaches.
1616

1717
## Features
1818

@@ -24,17 +24,17 @@ Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain
2424

2525
- **Themable:** Powerful customization options for all your needs. Style Web3 Onboard to fit into your existing designs, or pick from our pre-made themes.
2626

27-
- **Unified Provider Interface:** All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085 and EIP-3326 specifications. Whether your user is using Ledger or Metamask the provider will operate identically.
27+
- **Unified Provider Interface:** All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085, EIP-3326, and EIP-6963 specifications. Whether your user is using Ledger or Metamask, the provider will operate identically.
2828

29-
- **Dynamic Imports:** Supporting multiple wallets in your app requires a lot of dependencies. Onboard dynamically imports a wallet and its dependencies only when the user selects it, so that minimal bandwidth is used.
29+
- **Dynamic Imports:** Supporting multiple wallets in your app requires a lot of dependencies. Web3 Onboard dynamically imports a wallet and its dependencies only when the user selects it, so that minimal bandwidth is used.
3030

31-
- **Framework Agnostic:** Avoid framework lock in -- Web3-Onboard works with any framework and includes helper packages for vue & react.
31+
- **Framework Agnostic:** Avoid framework lock in -- Web3 Onboard works with any framework and includes helper packages for vue & react.
3232

3333
- **Notify:** Real-time transaction notifications for all transaction states for the connected wallet address(es). In-notification speedups & cancels for hardware wallet connections.
3434

3535
### Natively Supported EVM Chains
3636

37-
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).
37+
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).
3838

3939
- Ethereum
4040
- Arbitrum One
@@ -52,13 +52,14 @@ web3-onboard supports ALL EVM networks. Supporting a new network is simply a mat
5252
- Moonriver
5353
- Sepolia
5454
- Base Goerli
55+
- Degen
5556
- All other EVM networks
5657

57-
### Optional - Use an API key to fetch real time transaction data, balances & gas
58+
### Optional - Use an API key to fetch real-time transaction data, balances & gas
5859

59-
Using a Blocknative API key with web3-onboard on the free plan will allow you to gain the benefits of Blocknative balance & transaction services. Blocknative has a free forever plan you can always use.
60+
Using a Blocknative API key with Web3 Onboard on the free plan will allow you to gain the benefits of Blocknative balance & transaction services. Blocknative has a free forever plan you can always use.
6061

61-
This step is not required to use web3-onboard. You can skip to the [**Quickstart**](/docs/overview/introduction#quickstart) step below if you want to use web3-onboard without API services or if you already have a Blocknative account & API key.
62+
This step is not required to use Web3 Onboard. You can skip to the [**Quickstart**](/docs/overview/introduction#quickstart) step below if you want to use Web3 Onboard without API services or if you already have a Blocknative account & API key.
6263

6364
**Setup your Account**
6465
Go to the Account Dashboard at [https://explorer.blocknative.com/account](https://explorer.blocknative.com/account) and setup an account with an email address. You will receive an email to confirm your account.
@@ -68,7 +69,7 @@ On the Account Dashboard at [https://explorer.blocknative.com/account](https://e
6869

6970
## Quickstart
7071

71-
Install the core Onboard library, the injected wallets module and optionally ethers.js to support browser extension and mobile wallets:
72+
Install the core web3-onboard library, the injected wallets module, and optionally ethers.js to support browser extension and mobile wallets:
7273

7374
<Tabs values={['npm', 'yarn']}>
7475
<TabPanel value="yarn">
@@ -87,7 +88,7 @@ npm i @web3-onboard/core @web3-onboard/injected-wallets ethers
8788
</TabPanel>
8889
</Tabs>
8990

90-
You can find a link to web3-onboard's official NPM Documentation here: [@web3-onboard/core Official NPM Documentation](https://www.npmjs.com/package/@web3-onboard/core)
91+
You can find a link to Web3 Onboard's official NPM Documentation here: [@web3-onboard/core Official NPM Documentation](https://www.npmjs.com/package/@web3-onboard/core)
9192

9293
Then initialize in your app:
9394

@@ -171,9 +172,9 @@ if (wallets[0]) {
171172

172173
## Wallet Modules
173174

174-
Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your web3-onboard implementation. All modules can be accessed through the subpages of web3-onboard docs on the left.
175+
Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your Web3 Onboard implementation. All modules can be accessed through the subpages of Web3 Onboard docs on the left.
175176

176-
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.
177+
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, and more right away.
177178

178179
[**Core Repo**](../../modules/core.md#install)
179180

@@ -211,7 +212,7 @@ We recommend you add the [Core Repo](../../modules/core.md#install) and consider
211212

212213
## Test out the demo app
213214

214-
Test out the current functionality of web3-onboard in a small browser demo:
215+
Test out the current functionality of Web3 Onboard in a small browser demo:
215216

216217
- Clone the repo: `git clone git@github.com:blocknative/web3-onboard.git`
217218
- Change it to the onboard directory: `cd web3-onboard`
@@ -224,10 +225,10 @@ Test out the current functionality of web3-onboard in a small browser demo:
224225

225226
Checkout our live demo using React at [https://reactdemo.blocknative.com/](https://reactdemo.blocknative.com/)
226227

227-
The demo is open source so you can see a sample implementation of web3-onboard: [https://github.com/blocknative/react-demo](https://github.com/blocknative/react-demo)
228+
The demo is open source so you can see a sample implementation of Web3 Onboard: [https://github.com/blocknative/react-demo](https://github.com/blocknative/react-demo)
228229

229230
## More Examples
230231

231-
You can find starter examples from the web3 community here using web3-onboard:
232+
You can find starter examples from the web3 community here using Web3 Onboard:
232233

233234
- [eth-scaffold](https://github.com/scaffold-eth/scaffold-eth-examples/tree/bnc-onboard)

docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Example 2 : Bug fix within the `core` package -
4141

4242
## How can I add a new wallet? 💳
4343

44-
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.
44+
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 Web3 Onboard 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 developers looking to implement your wallet.
4545

4646
Please also include updates to documentation in your PR. Refer to the [docs contributions section](#documentation-contributions-📄) and the PR template docs checklist.
4747

@@ -69,7 +69,7 @@ PRs for adding/updating a wallet should include a README (new or updated) for th
6969

7070
[See here for an example of a docs pull request.](https://github.com/blocknative/web3-onboard/pull/1544/files)
7171

72-
We highly encourage the community to help us improve the web3-onboard docs! If you have any questions don't hesitate to reach out.
72+
We highly encourage the community to help us improve the Web3 Onboard docs! If you have any questions don't hesitate to [reach out](https://discord.com/invite/KZaBVME).
7373

7474
## Feedback 💬
7575

docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: 'Migration Guide from v1'
44

55
# Migration Guide from onboard.js to web3-onboard
66

7-
Follow the steps below to easily migrate from onboard.js to Web3-Onboard.
7+
Follow the steps below to easily migrate from onboard.js to Web3 Onboard.
88

99
### Background
1010

11-
With Web3-Onboard, we’ve introduced significant architectural changes that provide a more robust and efficient web3 onboarding experience. While this upgrade may result in breaking changes, the improved overall experience makes it worthwhile.
11+
With Web3 Onboard, we’ve introduced significant architectural changes that provide a more robust and efficient web3 onboarding experience. While this upgrade may result in breaking changes, the improved overall experience makes it worthwhile.
1212

1313
### Steps
1414

@@ -23,15 +23,15 @@ To help you get started quickly we’ve put together [a set of examples across m
2323

2424
### Package Upgrade - Modularization
2525

26-
This is the biggest change you might experience as an onboard.js user. With Web3-Onboard, we’ve separated all supported wallets into their modules, meaning you only need to integrate specific wallet modules you intend to support in your app.
26+
This is the biggest change you might experience as an onboard.js user. With Web3 Onboard, we’ve separated all supported wallets into their modules, meaning you only need to integrate specific wallet modules you intend to support in your app.
2727
For example with Onboard, if you wanted to support only Metamask and Coinbase in your app, you had to install Onboard complete with all other wallets: `npm install bnc-onboard`.
28-
With Web3-Onboard, you only need to install core along with the desired wallet modules: `npm i @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/coinbase`
28+
With Web3 Onboard, you only need to install core along with the desired wallet modules: `npm i @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/coinbase`
2929
This change allows us to support many web3 wallets without affecting the overall library performance.
3030

3131
### Expansive Initialization Options
3232

33-
We’ve made initialization simpler while introducing more powerful options like [Account Center](https://www.blocknative.com/blog/multichain-and-multiwallet-account-management-on-your-dapp-with-account-center) and Notify in Web3-Onboard.
34-
Onboard now requires two compulsory initial setup options: `wallets` (Wallet modules, as shown above, to be initialized and added to wallet selection modal) and `chains` (EVM networks your app should work with). You can also pass multiple wallets and chains.
33+
We’ve made initialization simpler while introducing more powerful options like [Account Center](https://www.blocknative.com/blog/multichain-and-multiwallet-account-management-on-your-dapp-with-account-center) and Notify in Web3 Onboard.
34+
Web3 Onboard now requires two compulsory initial setup options: `wallets` (Wallet modules, as shown above, to be initialized and added to wallet selection modal) and `chains` (EVM networks your app should work with). You can also pass multiple wallets and chains.
3535

3636
```
3737
const onboard = Onboard({
@@ -56,19 +56,19 @@ Now, you only need to call the connectWallet API:
5656

5757
`await onboard.connectWallet()`
5858

59-
Learn more about state changes tracked with the Onboard API [here](/docs/modules/core#state) and the exposed actions you can use to modify the state [here](/docs/modules/core#actions-to-modify-state).
59+
Learn more about state changes tracked with the Web3 Onboard API [here](/docs/modules/core#state) and the exposed actions you can use to modify the state [here](/docs/modules/core#actions-to-modify-state).
6060

6161
### Framework Support
6262

63-
Although Onboard is still framework-agnostic, we’ve introduced a couple of framework-specific modules that are frequently asked for by our users.
63+
Although Web3 Onboard is still framework-agnostic, we’ve introduced a couple of framework-specific modules that are frequently asked for by our users.
6464

65-
`@web3-onboard/react` - React Hooks to connect users to web3 dApps better. You can check out [a comprehensive React Hooks guide](https://www.blocknative.com/blog/react-hooks-ethereum) we've written on it.
65+
`@web3-onboard/react` - React Hooks to connect users to web3 dapps better. You can check out [a comprehensive React Hooks guide](https://www.blocknative.com/blog/react-hooks-ethereum) we've written on it.
6666

67-
`@web3-onboard/vue` - A set of reusable functions for integrating Web3-Onboard into a Vue 3 project. This is also compatible with a Vue 2 + composition-api dApp.
67+
`@web3-onboard/vue` - A set of reusable functions for integrating Web3 Onboard into a Vue 3 project. This is also compatible with a Vue 2 + composition-api dApp.
6868

6969
### CSS Customizations
7070

71-
We've also added more expansive custom CSS properties so you can style every part of your onboarding experience to match the overall experience of your dApp. To apply Web3-Onboard CSS customizations, you don't need to attach them to the `.bn-onboard-custom` class like before. Instead, you can simply place them in the `:root` CSS pseudo-class, as shown below:
71+
We've also added more expansive custom CSS properties so you can style every part of your onboarding experience to match the overall experience of your dApp. To apply Web3 Onboard CSS customizations, you don't need to attach them to the `.bn-onboard-custom` class like before. Instead, you can simply place them in the `:root` CSS pseudo-class, as shown below:
7272

7373
```
7474
:root {
@@ -90,11 +90,11 @@ We've also added more expansive custom CSS properties so you can style every par
9090
}
9191
```
9292

93-
The full list of CSS variables for web3-onboard is available [here](/docs/modules/core#custom-styling).
93+
The full list of CSS variables for Web3 Onboard is available [here](/docs/modules/core#custom-styling).
9494

9595
### Other Important Changes
9696

97-
There are also other notable infrastructural changes in Web3-Onboard:
97+
There are also other notable infrastructural changes in Web3 Onboard:
9898

9999
- Dynamic Imports of dependencies
100100
- Wallet Provider Standardization

docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: Installation
44

55
# {$frontmatter.title}
66

7-
Get up and running with Web3-Onboard
7+
Get up and running with Web3 Onboard
88

99
### Install
1010

11-
Install the core Onboard library and the injected wallets module to support browser extension and mobile wallets:
11+
Install the core Web3 Onboard library and the injected wallets module to support browser extension and mobile wallets:
1212

1313
<Tabs values={['yarn', 'npm']}>
1414
<TabPanel value="yarn">

docs/src/routes/docs/[...2]getting-started/[...2]theming/+page.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To customize the color theme of web3-onboard and match it with your dapp, you ca
88

99
## Available Themes
1010

11-
To set the color theme of web3-onboard to one of the available native themes, import Onboard from `@web3-onboard/core` and pass the theme as a string to the `theme` init option.
11+
To set the color theme of Web3 Onboard to one of the available native themes, import Web3 Onboard from `@web3-onboard/core` and pass the theme as a string to the `theme` init option.
1212

1313
| theme | description |
1414
| --------- | --------------------------------------------------------------------------------- |
@@ -32,7 +32,7 @@ const onboard = Onboard({
3232

3333
## Variables
3434

35-
In the table below, you'll find a list of css variables that you can use to theme web3-onboard.
35+
In the table below, you'll find a list of css variables that you can use to theme Web3 Onboard.
3636

3737
| variable | description |
3838
| ---------------------- | ----------------- |
@@ -47,7 +47,7 @@ In the table below, you'll find a list of css variables that you can use to them
4747

4848
## Custom Theme
4949

50-
To create a custom theme, you can define a `ThemingMap` object with CSS variables for different components of web3-onboard. Pass this object as the theme option.
50+
To create a custom theme, you can define a `ThemingMap` object with CSS variables for different components of Web3 Onboard. Pass this object as the theme option.
5151

5252
```typescript copy
5353
import Onboard, { ThemingMap } from '@web3-onboard/core'
@@ -71,7 +71,7 @@ const onboard = Onboard({
7171

7272
## Dynamically Update Theme with API
7373

74-
**`updateTheme`** is an exposed API method for actively updating the theme of web3-onboard. The function accepts `Theme` types (see below).
74+
**`updateTheme`** is an exposed API method for actively updating the theme of Web3 Onboard. The function accepts `Theme` types (see below).
7575
_If using the `@web3-onboard/react` package there is a hook exposed called `updateTheme`_
7676

7777
The function also accepts a custom built `ThemingMap` object that contains all or some of the theming variables
@@ -122,7 +122,7 @@ export type ThemingMap = {
122122
123123
## Theming Tool
124124
125-
You can preview how web3-onboard will look on your site by using our [theming tool](/theming-tool) to customize the look and feel of web3-onboard. You can try different themes or create your own and preview the result by entering a URL or adding a screenshot.
125+
You can preview how Web3 Onboard will look on your site by using our [theming tool](/theming-tool) to customize the look and feel of Web3 Onboard. You can try different themes or create your own and preview the result by entering a URL or adding a screenshot.
126126
127127
To do this:
128128

0 commit comments

Comments
 (0)