Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit 7af8090

Browse files
author
Dan Forbes
authored
fix(docs): introduction (#7083)
* More Improvements to the Introduction Page * Move Features of Web3.js v4 Section Back to Original Location * Fix Broken Link
1 parent 94f4f82 commit 7af8090

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

docs/docs/guides/getting_started/introduction.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,19 @@ This documentation is the entrypoint to Web3.js for developers. It covers [basic
2525
- Custom output [formatters](https://docs.web3js.org/api/web3-utils/function/format)
2626
- In compliance with the [Ethereum JSON-RPC Specification](https://ethereum.github.io/execution-apis/api-documentation/)
2727

28-
## Packages
28+
## Using These Docs
29+
30+
There is a lot to learn about Web3.js! Here are some tips for developers of different skill levels. Remember, you can always [reach out directly](/guides/feedback/#urgent-questions-or-concerns) with Discord or Twitter if you're feeling stuck.
31+
32+
### For Beginner Web3.js Developers
33+
34+
New Web3.js developers should proceed to the [Quickstart](/guides/getting_started/quickstart) section to learn how to get started with Web3.js. Once you understand the basics, you may want to consider learning more about [providers](/guides/web3_providers_guide/), [wallets and accounts](/guides/wallet/), [smart contracts](/guides/smart_contracts/smart_contracts_guide), and how to [use Web3.js with the Hardhat development environment](/guides/hardhat_tutorial/).
35+
36+
### For Intermediate & Advanced Web3.js Developers
37+
38+
If you're already familiar with Ethereum and Web3.js development, you may want to review the Web3.js [package structure](#packages--plugins) and proceed directly to the [package-level documentation](/libdocs/ABI) and [API documentation](/api). Application developers may wish to review the [Web3.js configuration guide](/guides/web3_config/) or learn how to use Web3.js with tools like the [MetaMask](/guides/wallet/metamask) wallet or the [WalletConnect](/guides/wallet/web3_modal_guide/) wallet selection modal. Don't forget to review the [list of available plugins](https://web3js.org/plugins) or even [learn how to build your own Web3.js plugin](/guides/web3_plugin_guide/plugin_authors)!
39+
40+
## Packages & Plugins
2941

3042
Web3.js is a modular collection of packages, each of which serves a specific needs. This means developers don't need to install the entire Web3 library for most use cases. Instead, necessary packages are selectively installed for a more efficient development experience. Here is an overview of a selection of available packages:
3143

@@ -61,6 +73,16 @@ Web3.js is a modular collection of packages, each of which serves a specific nee
6173

6274
- [**Web3 RPC Methods:**](/api/web3/namespace/rpcMethods) functions for making RPC requests to Ethereum using a given provider
6375

76+
### Plugins
77+
78+
Web3.js supports [plugins](/guides/web3_plugin_guide/), which are another way to encapsulate capabilities that support a specific need. There are plugins that exist to support native features, like those described by [EIPs](https://eips.ethereum.org/) as well as plugins that are designed to support specific smart contracts, middleware, or even other Ethereum-compatible networks. Visit the [Web3.js plugins homepage](https://web3js.org/plugins) to view a list of the most important Web3.js plugins, which includes:
79+
80+
- [EIP-4337 (Account Abstraction) Plugin](https://www.npmjs.com/package/@chainsafe/web3-plugin-eip4337)
81+
82+
- [EIP-4844 (Blob Transactions) Plugin](https://www.npmjs.com/package/web3-plugin-blob-tx)
83+
84+
- [zkSync Plugin](https://www.npmjs.com/package/web3-plugin-zksync)
85+
6486
## Advantages Over Other Libraries
6587

6688
- **Extensive Documentation and Community**: Web3.js is one of the most established Ethereum libraries, which means it benefits from extensive documentation and a large, active community. Web3.js is widely adopted and has been thoroughly tested in various production environments, and is compatible with a broad range of other tools and services in the Ethereum ecosystem.

docs/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ const config = {
123123
{
124124
to: '/libdocs/ABI',
125125
activeBasePath: '/libdocs',
126-
label: 'Documentation',
126+
label: 'Packages',
127127
position: 'left',
128128
},
129129
{

0 commit comments

Comments
 (0)