Proposal for rearranging docs (#6141)

* rework docs Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com> * fix broken links Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com> * fix verdaccio lockfile Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com> * fix plugin name Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com> * fix broken links after merge Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com> --------- Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
web3 · Jun 2, 2023 · 01ce365 · 01ce365
1 parent 86082bc
commit 01ce365
Show file tree

Hide file tree

Showing 41 changed files with 708 additions and 800 deletions.
diff --git a/docs/docs/guides/advanced/_category_.yml b/docs/docs/guides/advanced/_category_.yml
@@ -0,0 +1,5 @@
+label: 'Advanced'
+collapsible: true
+collapsed: true
+link: null
+position: 5
diff --git a/.../web3_tree_shaking_support_guide/index.md → .../web3_tree_shaking_support_guide/index.md b/.../web3_tree_shaking_support_guide/index.md → .../web3_tree_shaking_support_guide/index.md
@@ -1,9 +1,9 @@
 ---
 sidebar_position: 4
-sidebar_label: web3 Tree Shaking Guide
+sidebar_label: Tree Shaking Guide
 ---
 
-# web3 Tree shaking Support Guide
+# Tree shaking Support Guide
 
 1. Use the `production` mode configuration option to enable various optimizations including minification and tree shaking. Set your webpack.config:
 

diff --git a/docs/docs/guides/basics/_category_.yml b/docs/docs/guides/basics/_category_.yml
@@ -0,0 +1,5 @@
+label: 'Basic Interaction'
+collapsible: true
+collapsed: true
+link: null
+position: 3
diff --git a/docs/docs/tutorials/eth.md → docs/docs/guides/basics/eth.md b/docs/docs/tutorials/eth.md → docs/docs/guides/basics/eth.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 3
-sidebar_label: 'Using web3-eth package'
+sidebar_position: 2
+sidebar_label: 'Eth Package Usage Example'
 ---
 
 # Getting Started with `eth` Package

diff --git a/docs/docs/guides/basics/sign_and_send_tx/index.md b/docs/docs/guides/basics/sign_and_send_tx/index.md
@@ -0,0 +1,14 @@
+---
+sidebar_position: 1
+sidebar_label: 'Transactions'
+---
+
+# Sign and Send Transaction
+
+You can sign and send transactions in different ways.
+
+-   [Local wallet signing](./local_wallet)
+-   [Using raw transaction](./raw)
+-   [Using wallet of Eth Node](./wallet_of_eth_node)
+
+For each of them you can use [Web3PromiEvent](./promi_event) to catch extra transaction's events
diff --git a/...s/guides/sign_and_send_tx/local_wallet.md → ...s/basics/sign_and_send_tx/local_wallet.md b/...s/guides/sign_and_send_tx/local_wallet.md → ...s/basics/sign_and_send_tx/local_wallet.md
@@ -7,7 +7,7 @@ sidebar_label: 'Local wallet'
 
 The simplest way to sign and send transactions is using a local wallet:
 
-## Eth Transaction
+## Ethereum Transaction
 
 ```ts
 // First step: initialize `web3` instance

diff --git a/...cs/guides/sign_and_send_tx/promi_event.md → ...es/basics/sign_and_send_tx/promi_event.md b/...cs/guides/sign_and_send_tx/promi_event.md → ...es/basics/sign_and_send_tx/promi_event.md
diff --git a/docs/docs/guides/basics/sign_and_send_tx/raw.md b/docs/docs/guides/basics/sign_and_send_tx/raw.md
@@ -0,0 +1,10 @@
+---
+sidebar_position: 2
+sidebar_label: 'Raw Transaction'
+---
+
+# Using Raw Transaction
+
+:::note
+To be written!
+:::
diff --git a/...es/sign_and_send_tx/wallet_of_eth_node.md → ...cs/sign_and_send_tx/wallet_of_eth_node.md b/...es/sign_and_send_tx/wallet_of_eth_node.md → ...cs/sign_and_send_tx/wallet_of_eth_node.md
@@ -1,13 +1,13 @@
 ---
-sidebar_position: 2
-sidebar_label: 'Wallet of Eth Node'
+sidebar_position: 1
+sidebar_label: 'Node Wallet'
 ---
 
-# Using Wallet of Eth Node
+# Using Node Wallet
 
-If Eth node have unlocked account in its wallet you can send transaction without need of signing locally in web3.js
+If Ethereum node has unlocked account in its wallet you can send transaction without need of signing locally in web3.js
 
-## Eth Transaction
+## Transaction
 
 ```ts
 // First step: initialize web3 instance

diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md
@@ -0,0 +1,12 @@
+---
+slug: /
+sidebar_position: 1
+sidebar_label: Getting Started
+---
+
+# Getting Started
+
+Welcome to Web3.js Documentation.
+
+web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node using HTTP, IPC or WebSocket.
+The following documentation will guide you through different use cases of Web3.js, upgrading from older versions as well as providing an API reference documentation with examples.
diff --git a/docs/docs/guides/sign_and_send_tx/index.md b/docs/docs/guides/sign_and_send_tx/index.md
diff --git a/docs/docs/guides/sign_and_send_tx/raw.md b/docs/docs/guides/sign_and_send_tx/raw.md
diff --git a/...g_and_interacting_with_smart_contracts.md → ...g_and_interacting_with_smart_contracts.md b/...g_and_interacting_with_smart_contracts.md → ...g_and_interacting_with_smart_contracts.md
diff --git a/docs/docs/guides/smart_contracts/index.md b/docs/docs/guides/smart_contracts/index.md
@@ -0,0 +1,5 @@
+---
+sidebar_position: 4
+---
+
+# Smart Contracts
diff --git a/...uides/infer_contract_types_guide/index.md → ...racts/infer_contract_types_guide/index.md b/...uides/infer_contract_types_guide/index.md → ...racts/infer_contract_types_guide/index.md
diff --git a/docs/docs/guides/web3_plugin_guide/index.md b/docs/docs/guides/web3_plugin_guide/index.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 3
-sidebar_label: 'web3 Plugins'
+sidebar_position: 6
+sidebar_label: 'Plugins'
 ---
 
 # web3.js Plugins Guide

diff --git a/docs/docs/guides/web3_plugin_guide/plugin_authors.md b/docs/docs/guides/web3_plugin_guide/plugin_authors.md
@@ -1,14 +1,14 @@
 ---
-sidebar_position: 0
-sidebar_label: 'Plugin Authors'
+sidebar_position: 1
+sidebar_label: 'For Plugin Developers'
 ---
 
-# web3.js Plugin Author's Guide
+# web3.js Plugin Developer Guide
 
 This guide intends to provide the necessary context for developing plugins for web3.js.
 
 :::caution
-To provide type safety and IntelliSense for your plugin users, please refer to the [Setting Up Module Augmentation](/docs/guides/web3_plugin_guide/plugin_authors#setting-up-module-augmentation) section for how to augment the `Web3Context` module to enable typing features for your plugin.
+To provide type safety and IntelliSense for your plugin users, please refer to the [Setting Up Module Augmentation](#setting-up-module-augmentation) section for how to augment the `Web3Context` module to enable typing features for your plugin.
 :::
 
 ## Plugin Dependencies

diff --git a/docs/docs/guides/web3_plugin_guide/plugin_users.md b/docs/docs/guides/web3_plugin_guide/plugin_users.md
@@ -1,9 +1,9 @@
 ---
-sidebar_position: 1
-sidebar_label: 'Plugin Users'
+sidebar_position: 0
+sidebar_label: 'For Plugin Users'
 ---
 
-# web3.js Plugin User's Guide
+# Plugin User Guide
 
 This guide intends to provide the necessary context for registering plugins with web3.js packages.
 

diff --git a/docs/docs/guides/web3_providers_guide/events_listening.md b/docs/docs/guides/web3_providers_guide/events_listening.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 0
-sidebar_label: 'Providers Events Listening'
+sidebar_position: 1
+sidebar_label: 'Event Listening'
 ---
 
 # Providers Events Listening

diff --git a/docs/docs/tutorials/providers.md → ...s/guides/web3_providers_guide/examples.md b/docs/docs/tutorials/providers.md → ...s/guides/web3_providers_guide/examples.md
@@ -1,13 +1,8 @@
 ---
-sidebar_position: 2
-sidebar_label: Providers
+sidebar_label: Examples
 ---
 
-# Providers
-
-## Introduction
-
-web3.js providers are objects responsible for enabling connectivity with the Ethereum network in various ways. Connecting your web application to an Ethereum node is necessary for sending transactions, querying data, and interacting with smart contracts on the network. In this tutorial, we will explore the different types of providers available in web3.js version 4, how to set them up, and how to use them in your code.
+# Example usage
 
 ## Prerequisites
 
@@ -593,5 +588,3 @@ A few points to consider:
 ## Conclusion
 
 In this tutorial, we explored different types of providers available in web3.js and learned how to set them up and use them in our code. Depending on your application's needs, you can choose the provider that best suits your requirements. The HTTP Provider is the simplest and most widely used provider, while the Websocket Provider and IPC Provider offer real-time communication and faster performance, respectively. With these providers, you can connect your web application to the Ethereum network and start building decentralized applications.
-
-To get more about providers like more about their priorities and options, check the [web3.js Providers Guide](/docs/guides/web3_providers_guide/) and [Providers Events Listening Guide](/docs/guides/web3_providers_guide/events_listening)
diff --git a/docs/docs/guides/web3_providers_guide/index.md b/docs/docs/guides/web3_providers_guide/index.md
@@ -1,10 +1,14 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 sidebar_label: 'Providers'
 ---
 
 # web3.js Providers Guide
 
+## Introduction
+
+web3.js providers are objects responsible for enabling connectivity with the Ethereum network in various ways. Connecting your web application to an Ethereum node is necessary for sending transactions, querying data, and interacting with smart contracts on the network. In this guide, we will explore the different types of providers available in web3.js, how to set them up, and how to use them in your code.
+
 Connecting to a chain happens through a provider. You can pass the provider to the constructor as in the following example:
 
 ```ts

diff --git a/...b3_migration_guide/abi_migration_guide.md → ..._upgrade_guide/1.x/abi_migration_guide.md b/...b3_migration_guide/abi_migration_guide.md → ..._upgrade_guide/1.x/abi_migration_guide.md
diff --git a/...gration_guide/accounts_migration_guide.md → ...ade_guide/1.x/accounts_migration_guide.md b/...gration_guide/accounts_migration_guide.md → ...ade_guide/1.x/accounts_migration_guide.md
diff --git a/...ration_guide/contracts_migration_guide.md → ...de_guide/1.x/contracts_migration_guide.md b/...ration_guide/contracts_migration_guide.md → ...de_guide/1.x/contracts_migration_guide.md
diff --git a/...docs/guides/web3_migration_guide/index.md → ...cs/guides/web3_upgrade_guide/1.x/index.md b/...docs/guides/web3_migration_guide/index.md → ...cs/guides/web3_upgrade_guide/1.x/index.md
@@ -1,11 +1,11 @@
 ---
 sidebar_position: 1
-sidebar_label: 'Migration from 1.x'
+sidebar_label: 'Upgrade from 1.x'
 ---
 
-# Migration from 1.x
+# Upgrade from 1.x
 
-This migration guide is for migration from web3.js 1.x to web3.js 4.x.
+This upgrade guide is for upgrading from web3.js 1.x to web3.js 4.x.
 
 ## Breaking Changes
 
@@ -32,9 +32,9 @@ const web3 = new Web3();
 
 Passing callbacks to functions is no longer supported, except for event listeners.
 
-For example, the approach to subscribing-to and listening-for blockchain events has changed in version 4.x. Detailed instructions can be found in the [**`web3.eth.subscribe` Migration Guide**](/docs/guides/web3_migration_guide/subscribe_migration_guide#subscribing-to-events).
+For example, the approach to subscribing-to and listening-for blockchain events has changed in version 4.x. Detailed instructions can be found in the [**`web3.eth.subscribe` Migration Guide**](./subscribe_migration_guide.md#subscribing-to-events).
 
-However, the approach to subscribing to Provider events remains the same, utilizing callbacks as explained in the [Providers Events Listening guide](/docs/guides/web3_providers_guide/events_listening). It is important to note that Providers have undergone some breaking changes, including the renaming of the `on('close', ...)` to `on('disconnect', ...)`.
+However, the approach to subscribing to Provider events remains the same, utilizing callbacks as explained in the [Providers Events Listening guide](../../web3_providers_guide/events_listening.md). It is important to note that Providers have undergone some breaking changes, including the renaming of the `on('close', ...)` to `on('disconnect', ...)`.
 
 ### Not Implemented or Exported
 

diff --git a/...b3_migration_guide/net_migration_guide.md → ..._upgrade_guide/1.x/net_migration_guide.md b/...b3_migration_guide/net_migration_guide.md → ..._upgrade_guide/1.x/net_migration_guide.md
diff --git a/...gration_guide/personal_migration_guide.md → ...ade_guide/1.x/personal_migration_guide.md b/...gration_guide/personal_migration_guide.md → ...ade_guide/1.x/personal_migration_guide.md
diff --git a/...ration_guide/providers_migration_guide.md → ...de_guide/1.x/providers_migration_guide.md b/...ration_guide/providers_migration_guide.md → ...de_guide/1.x/providers_migration_guide.md
@@ -4,7 +4,7 @@ sidebar_position: 2
 sidebar_label: web3.providers
 ---
 
-For full description about the providers, their priorities and their types, you can check [web3.js Providers Guide](/docs/guides/web3_providers_guide/).
+For full description about the providers, their priorities and their types, you can check [web3.js Providers Guide](../../web3_providers_guide/).
 
 ### Provider Options Changes
 

diff --git a/...ration_guide/subscribe_migration_guide.md → ...de_guide/1.x/subscribe_migration_guide.md b/...ration_guide/subscribe_migration_guide.md → ...de_guide/1.x/subscribe_migration_guide.md
diff --git a/...ides/web3_migration_guide/web3_eth_ens.md → ...es/web3_upgrade_guide/1.x/web3_eth_ens.md b/...ides/web3_migration_guide/web3_eth_ens.md → ...es/web3_upgrade_guide/1.x/web3_eth_ens.md
diff --git a/...des/web3_migration_guide/web3_eth_iban.md → ...s/web3_upgrade_guide/1.x/web3_eth_iban.md b/...des/web3_migration_guide/web3_eth_iban.md → ...s/web3_upgrade_guide/1.x/web3_eth_iban.md
diff --git a/...gration_guide/web3_eth_migration_guide.md → ...ade_guide/1.x/web3_eth_migration_guide.md b/...gration_guide/web3_eth_migration_guide.md → ...ade_guide/1.x/web3_eth_migration_guide.md
diff --git a/...ation_guide/web3_utils_migration_guide.md → ...e_guide/1.x/web3_utils_migration_guide.md b/...ation_guide/web3_utils_migration_guide.md → ...e_guide/1.x/web3_utils_migration_guide.md
diff --git a/docs/docs/guides/web3_upgrade_guide/_category_.yml b/docs/docs/guides/web3_upgrade_guide/_category_.yml
@@ -0,0 +1,4 @@
+label: 'Upgrading'
+collapsible: true
+collapsed: false
+link: null