Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs structure & clarity #340

Merged
merged 3 commits into from
Aug 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/deweb/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Running a DeWeb server locally allows you to:
- Browse decentralized websites directly from the blockchain.
- Ensure complete privacy and autonomy in accessing on-chain data.

For detailed instructions, see [Setting up a Local Server](./setup-local-server).
For detailed instructions, see [Setting up a Local Server](../local-server-config/setup-local-server).

### Becoming a Provider

Expand All @@ -36,4 +36,14 @@ Becoming a provider of DeWeb lets you:
- Offer a gateway to the decentralized web for users on any platform (PC, mobile, tablet) without requiring them to install any software on their device.
- Manage a public-facing service with custom configurations.

For detailed instructions, see [Becoming a Provider](./setup-public-instance).
For detailed instructions, see [Becoming a Provider](../provider/setup-public-instance).

### Uploading a website

Uploading a website to the DeWeb lets you:

- host on-chain frontends
- protect business from DNS hacks
- build a truly decentralized dApp

For detailed instructions, see [upload a website to DeWeb](../cli/overview)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting up a Local Server
title: Setting up a local server
---

# Setting up a Local Server
Expand Down Expand Up @@ -73,7 +73,7 @@ By default, the DeWeb server runs on `localhost:8080`. You can access it using a

## Configuration

To customize your server settings, refer to the [Server Configuration](../configuration/server-config) page.
To customize your server settings, refer to the [Server Configuration](./server-config) page.

:::info Work in Progress
DeWeb is still a work in progress, and we are actively listening to feedback.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,18 @@ domain: "example.com"
network_node_url: "https://buildnet.massa.net/api/v2"
api_port: 8080
allow_list:
- "allowed-domain"
- "AS1Seo2..."
- "massaNameService"
- "AS1S...19b3"
block_list:
- "blocked-domain"
- "AS1REo4..."
- "massaNameService"
- "AS1S...4x3o"
```

The allow/block lists allow you to control which websites are accessible through your provider.
If there is any website in the allow list, all other websites are blocked.
You can use MNS domain names or smart contract addresses in these lists.

For more detailed settings and options, refer to the [Server Configuration](../configuration/server-config) page.
For more detailed settings and options, refer to the [Server Configuration](../local-server-config/server-config) page.

:::info Recommendation
We recommend running your own node and using your node's URL as the `network_node_url`.
Expand Down
17 changes: 13 additions & 4 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -511,15 +511,24 @@ const sidebars = {
collapsed: false,
items: [
"deweb/getting-started/overview",
"deweb/getting-started/setup-local-server",
"deweb/getting-started/setup-public-instance",
],
},
{
type: "category",
label: "Configuration",
label: "Acccessing DeWeb locally",
collapsed: false,
items: ["deweb/configuration/server-config"],
items: [
"deweb/local-server-config/setup-local-server",
"deweb/local-server-config/server-config"
],
},
{
type: "category",
label: "Becoming a provider",
collapsed: false,
items: [
"deweb/provider/setup-public-instance",
],
},
{
type: "category",
Expand Down
Loading