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

Commit 01ce365

Browse files
mpetrunicmpetrunic
authored
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>
1 parent 86082bc commit 01ce365

Some content is hidden

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

41 files changed

+708
-800
lines changed

‎docs/docs/guides/advanced/_category_.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label: 'Advanced'
2+
collapsible: true
3+
collapsed: true
4+
link: null
5+
position: 5

docs/docs/guides/web3_tree_shaking_support_guide/index.md renamed to docs/docs/guides/advanced/web3_tree_shaking_support_guide/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
sidebar_position: 4
3-
sidebar_label: web3 Tree Shaking Guide
3+
sidebar_label: Tree Shaking Guide
44
---
55

6-
# web3 Tree shaking Support Guide
6+
# Tree shaking Support Guide
77

88
1. Use the `production` mode configuration option to enable various optimizations including minification and tree shaking. Set your webpack.config:
99

‎docs/docs/guides/basics/_category_.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label: 'Basic Interaction'
2+
collapsible: true
3+
collapsed: true
4+
link: null
5+
position: 3

docs/docs/tutorials/eth.md renamed to docs/docs/guides/basics/eth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
sidebar_position: 3
3-
sidebar_label: 'Using web3-eth package'
2+
sidebar_position: 2
3+
sidebar_label: 'Eth Package Usage Example'
44
---
55

66
# Getting Started with `eth` Package

‎docs/docs/guides/basics/sign_and_send_tx/index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: 'Transactions'
4+
---
5+
6+
# Sign and Send Transaction
7+
8+
You can sign and send transactions in different ways.
9+
10+
- [Local wallet signing](./local_wallet)
11+
- [Using raw transaction](./raw)
12+
- [Using wallet of Eth Node](./wallet_of_eth_node)
13+
14+
For each of them you can use [Web3PromiEvent](./promi_event) to catch extra transaction's events

docs/docs/guides/sign_and_send_tx/local_wallet.md renamed to docs/docs/guides/basics/sign_and_send_tx/local_wallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: 'Local wallet'
77

88
The simplest way to sign and send transactions is using a local wallet:
99

10-
## Eth Transaction
10+
## Ethereum Transaction
1111

1212
```ts
1313
// First step: initialize `web3` instance

docs/docs/guides/sign_and_send_tx/promi_event.md renamed to docs/docs/guides/basics/sign_and_send_tx/promi_event.md

File renamed without changes.

‎docs/docs/guides/basics/sign_and_send_tx/raw.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
sidebar_position: 2
3+
sidebar_label: 'Raw Transaction'
4+
---
5+
6+
# Using Raw Transaction
7+
8+
:::note
9+
To be written!
10+
:::

docs/docs/guides/sign_and_send_tx/wallet_of_eth_node.md renamed to docs/docs/guides/basics/sign_and_send_tx/wallet_of_eth_node.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
sidebar_position: 2
3-
sidebar_label: 'Wallet of Eth Node'
2+
sidebar_position: 1
3+
sidebar_label: 'Node Wallet'
44
---
55

6-
# Using Wallet of Eth Node
6+
# Using Node Wallet
77

8-
If Eth node have unlocked account in its wallet you can send transaction without need of signing locally in web3.js
8+
If Ethereum node has unlocked account in its wallet you can send transaction without need of signing locally in web3.js
99

10-
## Eth Transaction
10+
## Transaction
1111

1212
```ts
1313
// First step: initialize web3 instance

‎docs/docs/guides/getting_started.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: /
3+
sidebar_position: 1
4+
sidebar_label: Getting Started
5+
---
6+
7+
# Getting Started
8+
9+
Welcome to Web3.js Documentation.
10+
11+
web3.js is a collection of libraries that allow you to interact with a local or remote ethereum node using HTTP, IPC or WebSocket.
12+
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.

0 commit comments

Comments
 (0)