Skip to content

Commit

Permalink
Merge pull request #344 from massalabs/qa-fix
Browse files Browse the repository at this point in the history
Docs DeWeb QA Fixes
  • Loading branch information
damip authored Aug 21, 2024
2 parents 6ec0409 + 58543b6 commit 9f10977
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 40 deletions.
16 changes: 9 additions & 7 deletions docs/deweb/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,20 @@ title: Overview

# Getting Started

Welcome to DeWeb! This guide will help you set up and start using DeWeb,
Welcome to the DeWeb! This guide will help you set up and start using the DeWeb,
whether you want to run a local server for personal use or become a provider.

## Introduction

DeWeb provides a fully decentralized web experience by allowing websites to be stored on-chain.
To start using DeWeb, you can choose between two primary paths:
The DeWeb provides a fully decentralized web experience by allowing websites to be stored on-chain.
To start using DeWeb, you can choose between three paths:

1. **Setting up a Local Server**:
Ideal for those who want to browse decentralized websites without any intermediaries.
2. **Becoming a Provider**:
Suitable for those who want to make decentralized websites accessible to anyone with a simple browser through their own domain.
3. **Uploading a website**:
Perfect is you want to upload your website on-chain.

## Paths to Get Started

Expand All @@ -30,7 +32,7 @@ For detailed instructions, see [Setting up a Local Server](../local-server-confi

### Becoming a Provider

Becoming a provider of DeWeb lets you:
Becoming a DeWeb provider lets you:

- Provide access to decentralized websites through your own domain.
- 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.
Expand All @@ -42,8 +44,8 @@ For detailed instructions, see [Becoming a Provider](../provider/setup-public-in

Uploading a website to the DeWeb lets you:

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

For detailed instructions, see [upload a website to DeWeb](../upload/cli)
37 changes: 19 additions & 18 deletions docs/deweb/home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@
title: Home
---

# Welcome to DeWeb
# Welcome to the DeWeb

DeWeb is your gateway to a fully decentralized web. Our vision is to create an on-chain web ecosystem with no intermediaries,
The DeWeb is your gateway to a fully decentralized web. Our vision is to create an on-chain web ecosystem with no intermediaries,
addressing security and reliability concerns associated with centralized servers.

## Our Vision

DeWeb aims to revolutionize the internet by enabling a fully decentralized web experience. By storing all websites on-chain,
The DeWeb aims to revolutionize the internet by enabling a fully decentralized web experience. By storing all websites on-chain,
we eliminate the risks associated with centralized servers, such as single points of failure and vulnerability to hacks.
This approach enhances security, ensuring that websites are resilient against censorship and attacks,
and provides true freedom and accessibility to everyone.

DeWeb allows developers to build and host their projects directly on the Massa blockchain.
The DeWeb allows developers to build and host their projects directly on the Massa blockchain.
This unique approach mitigates the risks of censorship and hacking, providing a seamless Web3 experience for users.
Developers can register ".massa" domains using MNS and store their websites' logic directly on the Massa blockchain,
ensuring applications are accessible directly from any browser of a user who installed DeWeb, without any intermediaries.
ensuring applications are accessible directly from any browser of a user who installed DeWeb server app, without any intermediaries.

## Decentralized Web Hosting

DeWeb enables developers to build and host both front-end and back-end components of DApps directly on the Massa blockchain.
The DeWeb enables developers to build and host both front-end and back-end components of DApps directly on the Massa blockchain.
This comprehensive on-chain hosting includes:

- **Domain Registration**: Register ".massa" domain names using the Massa Name Service (MNS) on the decentralized DNS,
Expand All @@ -41,7 +41,7 @@ It's also great builders & developers blockchain enthusiasts who want to build f

## Get Started

### Users: Access DeWeb
### Users: Access the DeWeb

#### Local-first DeWeb access

Expand All @@ -58,29 +58,22 @@ If you're not a developer or a visual learner check out [how to set up a local s

#### Provider access

To make DeWeb universally accessible without running a local server, providers are available.
To make the DeWeb universally accessible without running a local server, providers are available.

These providers allow users to access decentralized websites directly from their browsers,
making it easy to use DeWeb from anywhere and on devices that do not yet support DeWeb.
making it easy to use the DeWeb from anywhere and on devices that do not yet support DeWeb.

Here is a list of available providers:

- **Mainnet**: Coming Soon...
- **Buildnet**: [massa.network](https://massa.network), [massahub.network](https://massahub.network)

:::important
We are working on a provider registry system so you can have quick access to different Massa DeWeb providers.

This list will eventually be transferred to the registry.
:::

Examples of on-chain websites:
We are working on a provider registry system so you can have quick access to different Massa DeWeb providers.

| **Network** | **Provider** | **Provider URL** | Local URL |
|-------------|-------------------------|------------------------------------------------------|-----------|
| **Buildnet**| vesting.massa.network | [vesting.massa.network](http://vesting.massa.network)|vesting.localhost:8080
| **Buildnet**| mns.massa.network | [mns.massa.network](http://mns.massa.network) | mns.localhost:8080
| **Buildnet**| pur.massahub.network | [pur.massahub.network](http://pur.massahub.network) | pur.localhost:8080
:::


### Developers: Upload Your Website On the DeWeb
Expand All @@ -95,6 +88,14 @@ This means that your wallet needs to be setup to use the Buildnet, including the
If you encounter any issues or have suggestions, please let us know through our [issue tracker](https://github.com/massalabs/DeWeb/issues).
:::

## Examples of on-chain websites:

| **Network** | **Provider** | **Provider URL** | Local URL |
|-------------|-------------------------|------------------------------------------------------|-----------|
| **Buildnet**| vesting.massa.network | [vesting.massa.network](http://vesting.massa.network)|vesting.localhost:8080
| **Buildnet**| mns.massa.network | [mns.massa.network](http://mns.massa.network) | mns.localhost:8080
| **Buildnet**| pur.massahub.network | [pur.massahub.network](http://pur.massahub.network) | pur.localhost:8080


## Resources

Expand Down
8 changes: 4 additions & 4 deletions docs/deweb/local-server-config/server-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ domain: "massa.network"
network_node_url: "https://buildnet.massa.net/api/v2"
api_port: 8080
allow_list:
- "allowed-domain"
- "123456789abcdef"
- "massaNameService"
- "AS1S...19b3"
block_list:
- "blocked-domain"
- "abcdef123456789"
- "massaNameService"
- "AS1S...4x3o"
```
## Default Configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/deweb/provider/setup-public-instance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Becoming a Provider

# Becoming a Provider

Setting up a DeWeb provider allows you to provide access to decentralized websites through your own domain.
Setting up a DeWeb provider instance allows you to provide an access to decentralized websites through your own domain.
Follow these steps to get started.

:::caution Important Notice
Expand Down
10 changes: 5 additions & 5 deletions docs/deweb/upload/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Upload with the CLI

# DeWeb CLI

DeWeb CLI is a command-line tool designed for deploying, editing, and deleting decentralized websites on the DeWeb platform.
The DeWeb CLI is a command-line tool designed for deploying, editing, and deleting decentralized websites on the DeWeb platform.



Expand All @@ -20,7 +20,7 @@ On Windows, use `deweb-cli_{targetOS}.exe` instead of `./deweb-cli_{targetOS}`

## Usage

You can use the `deweb-cli` command to interact with DeWeb. Below is the basic usage syntax:
You can use the `deweb-cli` command to interact with the DeWeb. Below is the basic usage syntax:

```bash
deweb-cli [global options] command [command options] [arguments...]
Expand All @@ -36,7 +36,7 @@ deweb-cli [global options] command [command options] [arguments...]

### upload

Uploads a new website to the DeWeb platform.
Uploads a new website to the DeWeb.

```bash
deweb-cli upload [global options] <website_zip_file_path>
Expand Down Expand Up @@ -64,7 +64,7 @@ This should result in a zip file with all the files from the output directory, w
### edit

Edits an existing website on the DeWeb platform.
Edits an existing website on the DeWeb.

```bash
deweb-cli edit [global options] <website_sc_address> <website_zip_file_path>
Expand All @@ -83,7 +83,7 @@ deweb-cli edit -w myWallet -n http://node-url.com <website_sc_address> ./updated

### delete

Deletes an existing website from the DeWeb platform.
Deletes an existing website from the DeWeb.

```bash
deweb-cli delete [global options] <website_sc_address>
Expand Down
6 changes: 3 additions & 3 deletions docs/deweb/upload/mns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ To assign a MNS to your website navigate one of these links depending on your ne

##### 1) Minting a MNS

If you already have a MNS proceed to [step 2](mns#2-changing-msn-target).
If you already have a MNS proceed to [step 2](mns#2-changing-mns-target).

If you have no MNS minted on your prefferred network than you can mint one using the UI.

##### 2) Changing MSN Target
##### 2) Changing MNS Target

To have your MSN point at your website you need to change the target address.
To have your MNS point at your website you need to change the target address.

By default this address targets the owner address.

Expand Down
4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ const sidebars = {
},
{
type: "category",
label: "Acccessing DeWeb locally",
label: "Acccessing the DeWeb locally",
collapsed: false,
items: [
"deweb/local-server-config/setup-local-server",
Expand All @@ -532,7 +532,7 @@ const sidebars = {
},
{
type: "category",
label: "Uploading to DeWeb",
label: "Uploading to the DeWeb",
collapsed: false,
items: [
"deweb/upload/cli",
Expand Down

0 comments on commit 9f10977

Please sign in to comment.