Skip to content

Commit 914d059

Browse files
committed
Update documentation for MASQ Network, including renaming the web3 privacy browser, adding client redirects, and enhancing the sidebar structure.
- Changed title from 'MASQ Docs' to 'MASQ Network Documentation'. - Implemented client redirects for legacy paths to ensure smooth navigation. - Updated sidebar categories and labels for improved clarity and organization. - Removed outdated documentation related to the MASQ web3 privacy browser and consolidated relevant content. - Added linting step to CI workflows for better code quality assurance.
1 parent 8fe2a65 commit 914d059

41 files changed

Lines changed: 1732 additions & 318 deletions

Some content is hidden

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

.eslintrc.js

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/** @type {import('eslint').Linter.Config} */
2+
module.exports = {
3+
root: true,
4+
extends: ['plugin:@docusaurus/recommended'],
5+
env: {
6+
browser: true,
7+
node: true,
8+
es2022: true,
9+
},
10+
parserOptions: {
11+
ecmaVersion: 'latest',
12+
sourceType: 'module',
13+
ecmaFeatures: {
14+
jsx: true,
15+
},
16+
},
17+
ignorePatterns: [
18+
'build/',
19+
'.docusaurus/',
20+
'node_modules/',
21+
'working-docs/',
22+
'gitbook-src/',
23+
],
24+
};

.github/workflows/deploy.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ jobs:
1919
cache: npm
2020
- name: Install dependencies
2121
run: npm ci
22+
- name: Lint
23+
run: npm run lint
2224
- name: Build website
2325
run: npm run build
2426
- name: Upload Build Artifact

.github/workflows/test-deploy.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,7 @@ jobs:
2323
cache: npm
2424
- name: Install dependencies
2525
run: npm ci
26+
- name: Lint
27+
run: npm run lint
2628
- name: Test build website
2729
run: npm run build

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,5 +140,5 @@ When continuing polish / visual QA (see `working-docs/HANDOVER-HARDENING.md` if
140140
```powershell
141141
git status -sb
142142
npm run build
143-
# spot-check: npm start → /, /masq-web3-privacy-browser, /resources/installer-checksums
143+
# spot-check: npm start → /, /masq-privacy-browser, /resources/installer-checksums
144144
```
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
import DocCardList from '@theme/DocCardList';
2+
13
# CLI Startup Guides
24

3-
This are targeting to Quality Assurance (QA) testing for our development, but will be helpful for you to prepare your machine to run from Command Line (CLI)
5+
These guides target Quality Assurance (QA) testing for our development, but they also help you prepare a machine to run MASQ from the command line (CLI).
46

57
:::warning
68

79
Running MASQ from CLI **will** require technical knowledge and possibly adjustments to the network adaptor settings.
810

911
MASQ and the developers are not responsible for any issues that arise from user changes to their environment or machine!
1012

11-
:::
13+
:::
14+
15+
<DocCardList />

docs/core-concepts/cores-packages/index.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import DocCardList from '@theme/DocCardList';
2+
13
# CORES Packages
24

35
A CORE(s) package is a series of instructions bundled in a way that allows each node within the network to receive just enough information to make a decision on how to handle a request. CORES stands for **C**lient-**O**rigin-**R**elay-**E**xit-**S**erver
@@ -14,4 +16,6 @@ Each Node that handles a CORES package plays a specific role in the life-cycle o
1416
* **Originator:** The identity of the originating request node.
1517
* **Relay:** Identifies Nodes that will be used to hop along routes to get to its destination.
1618
* **Exit:** The exit node will make the true web request on behalf of the originator and send it back along the route stack.
17-
* **Server:** Information about the server that is hosting the requested information.
19+
* **Server:** Information about the server that is hosting the requested information.
20+
21+
<DocCardList />

docs/core-concepts/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
# 📑 Core Concepts
1+
import DocCardList from '@theme/DocCardList';
2+
3+
# Core Concepts
4+
5+
How the MASQ Network works under the hood — neighborhoods, gossip, CORES packages, encryption, and clandestine routing.
6+
7+
<DocCardList />
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
import DocCardList from '@theme/DocCardList';
2+
13
# MASQ Neighborhoods
24

35
Each MASQ Node in the MASQ Network contains a subsystem that we call the Neighborhood. The Neighborhood is responsible for keeping track of other Nodes in the network, remembering how (and whether) they're connected to one another, and storing other information about them as well.
46

57
Currently, there are plans for neighborhoods to also remember things like when they were last used, what region they are operating in, how fast they have proven to be and whether they're acting suspiciously. Also, whenever a consuming Node wants to send a CORES package through the network, its Neighborhood is responsible for analyzing the network and determining what route the CORES package should take. This takes place through a 'routing engine' in the Node which evaluates all possible known routes in the Neighborhood and ranks them according to the most desirable (usually based on price of the route, number of hops etc).
68

79
The concept of MASQ Neighborhoods is also such that no single MASQ Node will be able to have awareness or knowledge of the entire MASQ Network - neighborhoods have a limitation in number of Nodes within reach of the Gossip protocol.
10+
11+
<DocCardList />

docs/developers/dev-docs/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Technical Documentation
22

3-
Some helpful documentation and notes for developers
3+
Some helpful documentation and notes for developers.
44

5-
More information and links to README files from our Node repo will be added periodically
5+
More information and links to README files from our Node repo will be added periodically.

docs/ecosystem-accelerator/summary/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
MASQ Network is proud to announce the initiation of its Ecosystem Accelerator. This program is a strategic effort to foster growth within the MASQ ecosystem - by honouring and rewarding users, developers and community members who bring growth and innovation within MASQ’s web3 privacy space.
44

5-
**The Ecosystem Accelerator Program reflects our unwavering commitment to fostering a vibrant and dynamic ecosystem, where community engagement and development are not just encouraged, but actively facilitated.**&#x20;
5+
**The Ecosystem Accelerator Program reflects our unwavering commitment to fostering a vibrant and dynamic ecosystem, where community engagement and development are not just encouraged, but actively facilitated.**
66

77
***
88

0 commit comments

Comments
 (0)