Skip to content

Commit e2fb007

Browse files
Adán Sánchez de Pedro Crespogitbook-bot
Adán Sánchez de Pedro Crespo
authored andcommitted
GitBook: [#77] No subject
1 parent c5a0208 commit e2fb007

20 files changed

+50
-50
lines changed

Diff for: README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@ The Witnet oracle is currently available on Ethereum, Polygon, Avalanche, Celo,
1212

1313
### Featured sections
1414

15-
{% content-ref url="introduction/about/wit-coin.md" %}
16-
[wit-coin.md](introduction/about/wit-coin.md)
15+
{% content-ref url="intro/about/wit-coin.md" %}
16+
[wit-coin.md](intro/about/wit-coin.md)
1717
{% endcontent-ref %}
1818

1919
{% content-ref url="smart-contracts/supported-chains.md" %}
2020
[supported-chains.md](smart-contracts/supported-chains.md)
2121
{% endcontent-ref %}
2222

23-
{% content-ref url="introduction/quick-tutorials/data-feeds-tutorial.md" %}
24-
[data-feeds-tutorial.md](introduction/quick-tutorials/data-feeds-tutorial.md)
23+
{% content-ref url="intro/tutorials/data-feeds-tutorial.md" %}
24+
[data-feeds-tutorial.md](intro/tutorials/data-feeds-tutorial.md)
2525
{% endcontent-ref %}
2626

27-
{% content-ref url="introduction/quick-tutorials/randomness.md" %}
28-
[randomness.md](introduction/quick-tutorials/randomness.md)
27+
{% content-ref url="intro/tutorials/randomness.md" %}
28+
[randomness.md](intro/tutorials/randomness.md)
2929
{% endcontent-ref %}
3030

31-
{% content-ref url="introduction/quick-tutorials/apis-and-http-get-post.md" %}
32-
[apis-and-http-get-post.md](introduction/quick-tutorials/apis-and-http-get-post.md)
31+
{% content-ref url="intro/tutorials/apis-and-http-get-post.md" %}
32+
[apis-and-http-get-post.md](intro/tutorials/apis-and-http-get-post.md)
3333
{% endcontent-ref %}
3434

35-
{% content-ref url="introduction/quick-tutorials/mining-wit.md" %}
36-
[mining-wit.md](introduction/quick-tutorials/mining-wit.md)
35+
{% content-ref url="intro/tutorials/mining-wit.md" %}
36+
[mining-wit.md](intro/tutorials/mining-wit.md)
3737
{% endcontent-ref %}
3838

39-
{% content-ref url="introduction/about/awesome-witnet.md" %}
40-
[awesome-witnet.md](introduction/about/awesome-witnet.md)
39+
{% content-ref url="intro/about/awesome-witnet.md" %}
40+
[awesome-witnet.md](intro/about/awesome-witnet.md)
4141
{% endcontent-ref %}

Diff for: SUMMARY.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
* [🏠 Witnet Oracle Docs](README.md)
44

5-
## Introduction
5+
## Introduction <a href="#intro" id="intro"></a>
66

7-
* [❓ What is Witnet?](introduction/about/README.md)
8-
* [⚙ Architecture](introduction/about/architecture.md)
9-
* [🤔 Frequently Asked Questions](introduction/about/frequently-asked-questions.md)
10-
* [🪙 The Witnet Coin (Wit)](introduction/about/wit-coin.md)
11-
* [👛 Sheikah Witnet Wallet](introduction/about/sheikah-witnet-wallet.md)
12-
* [😎 Awesome Witnet](introduction/about/awesome-witnet.md)
13-
* [🚀 Quick Tutorials](introduction/quick-tutorials/README.md)
14-
* [📈 Price Feeds](introduction/quick-tutorials/data-feeds-tutorial.md)
15-
* [🔀 Randomness](introduction/quick-tutorials/randomness.md)
16-
* [📡 APIs and HTTP GET/POST](introduction/quick-tutorials/apis-and-http-get-post.md)
17-
* [⛏ Mining Wit](introduction/quick-tutorials/mining-wit.md)
7+
* [❓ What is Witnet?](intro/about/README.md)
8+
* [Oracle Architecture](intro/about/architecture.md)
9+
* [🪙 The Witnet Coin (Wit)](intro/about/wit-coin.md)
10+
* [👛 Sheikah Witnet Wallet](intro/about/sheikah-witnet-wallet.md)
11+
* [🤔 Frequently Asked Questions](intro/about/frequently-asked-questions.md)
12+
* [😎 Awesome Witnet](intro/about/awesome-witnet.md)
13+
* [🚀 Quick Tutorials](intro/tutorials/README.md)
14+
* [📈 Price Feeds](intro/tutorials/data-feeds-tutorial.md)
15+
* [🔀 Randomness](intro/tutorials/randomness.md)
16+
* [📡 APIs and HTTP GET/POST](intro/tutorials/apis-and-http-get-post.md)
17+
* [⛏ Mining Wit](intro/tutorials/mining-wit.md)
1818

1919
## Smart contract developers <a href="#smart-contracts" id="smart-contracts"></a>
2020

@@ -55,14 +55,14 @@
5555
* [🖥 Requirements](node-operators/requirements.md)
5656
* [🚀 Docker Quick Start Guide](node-operators/docker-quick-start-guide.md)
5757
* [🔎 Next steps](node-operators/next-steps.md)
58-
* [📄 CLI Reference](node-operators/cli-reference.md)
58+
* [📄 CLI Reference](node-operators/cli.md)
5959
* [🤓 Advanced Setups](node-operators/advanced-setups/README.md)
60-
* [Run Witnet as a systemd service](node-operators/advanced-setups/run-witnet-as-a-systemd-service.md)
61-
* [Run Witnet as a docker-compose service](node-operators/advanced-setups/run-witnet-as-a-docker-compose-service.md)
60+
* [Run Witnet as a systemd service](node-operators/advanced-setups/systemd.md)
61+
* [Run Witnet as a docker-compose service](node-operators/advanced-setups/docker-compose.md)
6262

6363
## Developer Reference
6464

65-
* [Integration Guide](developer-reference/integrations/README.md)
65+
* [🏗 Integration Guide](developer-reference/integrations/README.md)
6666
* [Node API Reference](developer-reference/integrations/node-api.md)
6767
* [Wallet API Reference](developer-reference/integrations/wallet-api.md)
68-
* [Compile witnet-rust from Source Code](developer-reference/compile-witnet-rust-from-source-code.md)
68+
* [🗜 Compile witnet-rust from Source Code](developer-reference/compile-from-source-code.md)

Diff for: developer-reference/compile-witnet-rust-from-source-code.md renamed to developer-reference/compile-from-source-code.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Compile witnet-rust from Source Code
1+
# 🗜 Compile witnet-rust from Source Code
22

33
## Install compilation dependencies
44

Diff for: developer-reference/integrations/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: >-
55
balances, and create and verify transactions.
66
---
77

8-
# Integration Guide
8+
# 🏗 Integration Guide
99

1010
### Running Witnet-Rust
1111

@@ -14,9 +14,9 @@ The Witnet Foundation-supported reference implementation of the Witnet protocol
1414
Witnet-Rust can be easily run:
1515

1616
* [as a Docker container](../../node-operators/docker-quick-start-guide.md)
17-
* [as a docker-compose service](../../node-operators/advanced-setups/run-witnet-as-a-docker-compose-service.md)
18-
* [as a systemd service](../../node-operators/advanced-setups/run-witnet-as-a-systemd-service.md)
19-
* [compiling from source code](../compile-witnet-rust-from-source-code.md)
17+
* [as a docker-compose service](../../node-operators/advanced-setups/docker-compose.md)
18+
* [as a systemd service](../../node-operators/advanced-setups/systemd.md)
19+
* [compiling from source code](../compile-from-source-code.md)
2020

2121
### Witnet-Rust Components
2222

@@ -58,10 +58,10 @@ The full list of supported JSON-RPC methods is available in the [Node API Refere
5858
[node-api.md](node-api.md)
5959
{% endcontent-ref %}
6060

61-
There is also a [command line client (CLI)](../../node-operators/cli-reference.md) that exposes all the node functionality and uses the JSON-RPC API under the hood:
61+
There is also a [command line client (CLI)](../../node-operators/cli.md) that exposes all the node functionality and uses the JSON-RPC API under the hood:
6262

63-
{% content-ref url="../../node-operators/cli-reference.md" %}
64-
[cli-reference.md](../../node-operators/cli-reference.md)
63+
{% content-ref url="../../node-operators/cli.md" %}
64+
[cli.md](../../node-operators/cli.md)
6565
{% endcontent-ref %}
6666

6767
### Witnet-Rust `wallet` component
File renamed without changes.

Diff for: introduction/about/architecture.md renamed to intro/about/architecture.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ⚙ Architecture
1+
# Oracle Architecture
22

33
{% hint style="info" %}
44
This article explores the characteristics and intricacies of Witnet from a purely internal perspective. This can be useful to understand the processes supporting the security and data integrity properties of the protocol.
@@ -25,7 +25,7 @@ Having its own blockchain also guarantees that the fate of the Witnet oracle is
2525
{% hint style="success" %}
2626
Even though Witnet runs on its own blockchain, it is connected to the most popular smart contract enabled blockchains, and from the perspective of the average smart contract developer, using Witnet feels totally like using a native contract on each of those chains.
2727

28-
In addition, many oracle use cases (like [price feeds](../quick-tutorials/data-feeds-tutorial.md) or [random number generation](../quick-tutorials/randomness.md)) are also served through simpler interfaces that do not require the user to create and deploy any data requests.
28+
In addition, many oracle use cases (like [price feeds](../tutorials/data-feeds-tutorial.md) or [random number generation](../tutorials/randomness.md)) are also served through simpler interfaces that do not require the user to create and deploy any data requests.
2929
{% endhint %}
3030

3131
### Capabilities of Data Requests
@@ -42,9 +42,9 @@ Namely, data requests allow to:
4242

4343
The Witnet protocol was designed to be agnostic over the nature of the sourced data, and currently supports the following types of data sources:
4444

45-
* [HTTP GET,](../quick-tutorials/apis-and-http-get-post.md) which easily allows to read from most [REST APIs](../quick-tutorials/apis-and-http-get-post.md) today.
46-
* [HTTP POST](../quick-tutorials/apis-and-http-get-post.md), which provides a convenient way to query more sophisticated [REST and GraphQL APIs](../quick-tutorials/apis-and-http-get-post.md).
47-
* [RNG](../quick-tutorials/randomness.md), which allows to generate [random numbers and byte arrays](../quick-tutorials/randomness.md).
45+
* [HTTP GET,](../tutorials/apis-and-http-get-post.md) which easily allows to read from most [REST APIs](../tutorials/apis-and-http-get-post.md) today.
46+
* [HTTP POST](../tutorials/apis-and-http-get-post.md), which provides a convenient way to query more sophisticated [REST and GraphQL APIs](../tutorials/apis-and-http-get-post.md).
47+
* [RNG](../tutorials/randomness.md), which allows to generate [random numbers and byte arrays](../tutorials/randomness.md).
4848

4949
{% hint style="success" %}
5050
Witnet uses an RFC-8949 based binary format named RADON to encode and decode data requests.

Diff for: introduction/about/awesome-witnet.md renamed to intro/about/awesome-witnet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: >-
44
other relevant information to learn everything Witnet.
55
---
66

7-
# 💥 Awesome Witnet
7+
# 😎 Awesome Witnet
88

99
### Official materials
1010

File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: introduction/quick-tutorials/mining-wit.md renamed to intro/tutorials/mining-wit.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ There are multiple ways to run a Witnet validator node. Listed below are the mos
3030

3131
#### **As a `docker-compose` Service**
3232

33-
{% content-ref url="../../node-operators/advanced-setups/run-witnet-as-a-docker-compose-service.md" %}
34-
[run-witnet-as-a-docker-compose-service.md](../../node-operators/advanced-setups/run-witnet-as-a-docker-compose-service.md)
33+
{% content-ref url="../../node-operators/advanced-setups/docker-compose.md" %}
34+
[docker-compose.md](../../node-operators/advanced-setups/docker-compose.md)
3535
{% endcontent-ref %}
3636

3737
**As a `systemd` Service**
3838

39-
{% content-ref url="../../node-operators/advanced-setups/run-witnet-as-a-systemd-service.md" %}
40-
[run-witnet-as-a-systemd-service.md](../../node-operators/advanced-setups/run-witnet-as-a-systemd-service.md)
39+
{% content-ref url="../../node-operators/advanced-setups/systemd.md" %}
40+
[systemd.md](../../node-operators/advanced-setups/systemd.md)
4141
{% endcontent-ref %}
4242

4343
### **What To Expect When Running a Witnet Node**
File renamed without changes.
File renamed without changes.

Diff for: node-operators/docker-quick-start-guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
{% hint style="info" %}
66
You do not need to run a Witnet node to use Witnet from your Ethereum smart contracts.
77

8-
If you are a smart contracts developer, what you probably want is to use one of the [data feeds](../introduction/quick-tutorials/data-feeds-tutorial.md), a [randomness source](../introduction/quick-tutorials/randomness.md), or to connect to [APIs with HTTP GET/POST](../introduction/quick-tutorials/apis-and-http-get-post.md).
8+
If you are a smart contracts developer, what you probably want is to use one of the [data feeds](../intro/tutorials/data-feeds-tutorial.md), a [randomness source](../intro/tutorials/randomness.md), or to connect to [APIs with HTTP GET/POST](../intro/tutorials/apis-and-http-get-post.md).
99
{% endhint %}
1010

1111
### Hardware requirements <a href="#hardware-requirements" id="hardware-requirements"></a>
@@ -18,7 +18,7 @@ Hardware requirements are listed in the node operators docs:
1818

1919
### Up and running in 1 minute, using Docker <a href="#up-and-running-in-1-minute-using-docker" id="up-and-running-in-1-minute-using-docker"></a>
2020

21-
The most convenient method for running a Witnet node is through the `witnet/witnet-rust` Docker image. For alternate installation methods or more complex setups, take a look at the [docker-compose](advanced-setups/run-witnet-as-a-docker-compose-service.md) and [systemd](advanced-setups/run-witnet-as-a-systemd-service.md) integrations.
21+
The most convenient method for running a Witnet node is through the `witnet/witnet-rust` Docker image. For alternate installation methods or more complex setups, take a look at the [docker-compose](advanced-setups/docker-compose.md) and [systemd](advanced-setups/systemd.md) integrations.
2222

2323
Firstly, you need to [install Docker](https://docs.docker.com/get-docker/) on the device you will be running the node from. Note: some GNU/Linux distributions require some [extra steps](https://docs.docker.com/install/linux/linux-postinstall/) to get Docker up and running.
2424

Diff for: node-operators/next-steps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Join the [Witnet community](https://t.me/witnetio) and the [Witnet OTC community
3333

3434
## Monitoring your node's progress
3535

36-
Here are some useful commands that you can use to keep track of how your node is performing in the network. A complete documentation of all the CLI methods is available in the node [operator docs](cli-reference.md).
36+
Here are some useful commands that you can use to keep track of how your node is performing in the network. A complete documentation of all the CLI methods is available in the node [operator docs](cli.md).
3737

3838
### nodeStats
3939

0 commit comments

Comments
 (0)