From 1b15de03c3e544efb26299fa40a7e7e3b74ead4c Mon Sep 17 00:00:00 2001
From: Keith Millette <keith@xx.network>
Date: Mon, 17 Jun 2024 13:03:37 +0900
Subject: [PATCH] Pre-deploy config changes.
---
website/docs/cmixx/design-specs/README.md | 4 +---
website/docs/cmixx/design-specs/architecture.md | 2 +-
website/docs/cmixx/design-specs/cmixx.md | 2 +-
website/docs/cmixx/design-specs/end_to_end.md | 6 +++---
website/docs/cmixx/design-specs/gateway_gossip.md | 2 +-
website/docs/cmixx/design-specs/gateway_mixing.md | 2 +-
website/docs/cmixx/design-specs/message_pickup.md | 2 +-
.../docs/cmixx/design-specs/multicast_channel.md | 6 +++---
website/docs/cmixx/design-specs/pki.md | 2 +-
website/docs/cmixx/design-specs/threat_model.md | 2 +-
website/docs/cmixx/design-specs/wire.md | 2 +-
website/docs/dapps/intro.md | 6 ------
website/docs/dapps/phoenixx.md | 3 ++-
website/docs/dapps/proxxy.md | 2 +-
website/docs/dapps/usecases/test.md | 0
website/docs/dapps/xxm.md | 2 +-
website/docs/intro.md | 14 ++++++++++----
website/docs/tools/dashboard.md | 4 ++++
website/docs/tools/explorer.md | 4 ++++
website/docs/tools/simpleStaking.md | 3 +++
website/docs/tools/sleeve.md | 5 ++++-
.../tools/webWallet/governance/councilElections.md | 2 +-
website/docusaurus.config.js | 6 +++---
23 files changed, 48 insertions(+), 35 deletions(-)
delete mode 100644 website/docs/dapps/intro.md
delete mode 100644 website/docs/dapps/usecases/test.md
diff --git a/website/docs/cmixx/design-specs/README.md b/website/docs/cmixx/design-specs/README.md
index 4863bf8..1e24001 100644
--- a/website/docs/cmixx/design-specs/README.md
+++ b/website/docs/cmixx/design-specs/README.md
@@ -1,8 +1,6 @@
-# cMixx Design Specifications
+# Overview
Technical design specification documentation for the xx network, a cMixx implementation.
-These documents are a work-in-progress and are continually evolving as we improve
-our software.
- [Architectural Overview](architecture.md)
diff --git a/website/docs/cmixx/design-specs/architecture.md b/website/docs/cmixx/design-specs/architecture.md
index 84fcc59..ece59b7 100644
--- a/website/docs/cmixx/design-specs/architecture.md
+++ b/website/docs/cmixx/design-specs/architecture.md
@@ -1,5 +1,5 @@
-# Elixxir Mixnet Architectural Overview
+# Architectural Overview
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/cmixx.md b/website/docs/cmixx/design-specs/cmixx.md
index b0f5bd5..39b4db7 100644
--- a/website/docs/cmixx/design-specs/cmixx.md
+++ b/website/docs/cmixx/design-specs/cmixx.md
@@ -1,4 +1,4 @@
-# The xx network cMix Design Specification
+# cMixx Design Specification
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/end_to_end.md b/website/docs/cmixx/design-specs/end_to_end.md
index 7c62762..27b851e 100644
--- a/website/docs/cmixx/design-specs/end_to_end.md
+++ b/website/docs/cmixx/design-specs/end_to_end.md
@@ -1,5 +1,5 @@
-# The xx network End To End Cryptographic Protocol
+# End To End Cryptographic Protocol
Benjamin Wenger
Richard T. Carback III
@@ -214,7 +214,7 @@ the following common nested structures:
* cMix Message: This message is the outer most protocol message and is
responsible for routing the message through the network in such a manner
- as to leak very little metadata. See our [cMix section](cmix.md) for
+ as to leak very little metadata. See our [cMix section](cmixx.md) for
a detailed discussion. Suffice it to say here we note that this message
encapsulates an encrypted Payload field.
@@ -395,7 +395,7 @@ makes use of a stream cipher and MAC:
```
In the future we'd like to replace this with an AEAD. The Encrypt
also sets the message fingerprint field of the cMix message. Please
-see our [cMix design document](cmix.md) for more detailed information
+see our [cMix design document](cmixx.md) for more detailed information
about the cMix message format.
diff --git a/website/docs/cmixx/design-specs/gateway_gossip.md b/website/docs/cmixx/design-specs/gateway_gossip.md
index 04e1abe..b74fef8 100644
--- a/website/docs/cmixx/design-specs/gateway_gossip.md
+++ b/website/docs/cmixx/design-specs/gateway_gossip.md
@@ -1,4 +1,4 @@
-# The xx network Gateway Gossip Protocol
+# Gateway Gossip Protocol
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/gateway_mixing.md b/website/docs/cmixx/design-specs/gateway_mixing.md
index cf503c1..0eb5645 100644
--- a/website/docs/cmixx/design-specs/gateway_mixing.md
+++ b/website/docs/cmixx/design-specs/gateway_mixing.md
@@ -1,4 +1,4 @@
-## XX Network Gateway Mixing
+# Gateway Mixing
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/message_pickup.md b/website/docs/cmixx/design-specs/message_pickup.md
index 7ab50be..5f9a455 100644
--- a/website/docs/cmixx/design-specs/message_pickup.md
+++ b/website/docs/cmixx/design-specs/message_pickup.md
@@ -1,4 +1,4 @@
-# The xx network message pickup design
+# Message Pickup
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/multicast_channel.md b/website/docs/cmixx/design-specs/multicast_channel.md
index e4dcf68..6de1ada 100644
--- a/website/docs/cmixx/design-specs/multicast_channel.md
+++ b/website/docs/cmixx/design-specs/multicast_channel.md
@@ -1,4 +1,4 @@
-# The xx Network Multicast Channel Design
+# Multicast Channel Design
Benjamin Wenger
Richard T. Carback III
@@ -169,7 +169,7 @@ key reuse; under the assumption that at least one of the message senders
is honest.
The `nonce` is stored in the cMix `Fingerprint` field. Note that this is
-the `nonce` and NOT the `computed_nonce`. See our [cmix design doc](cmix.md)
+the `nonce` and NOT the `computed_nonce`. See our [cmix design doc](cmixx.md)
for details about the cMix message format.
### Message Encapsulation
@@ -210,7 +210,7 @@ The collision resistance of the hash guarantees the uniqueness of the message ID
Message encryption uses XChaCha20 which produces a cryptographically
malleable ciphertext. Thus we compute a MAC (message authentication
code) as well. The MAC is placed in the MAC field of the cMix
-message. See our [cmix design doc](cmix.md) for details about the cMix
+message. See our [cmix design doc](cmixx.md) for details about the cMix
message format.
diff --git a/website/docs/cmixx/design-specs/pki.md b/website/docs/cmixx/design-specs/pki.md
index 3d29bc7..6528489 100644
--- a/website/docs/cmixx/design-specs/pki.md
+++ b/website/docs/cmixx/design-specs/pki.md
@@ -1,5 +1,5 @@
-# Elixxir Mixnet PKI
+# cMixx Mixnet PKI
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/threat_model.md b/website/docs/cmixx/design-specs/threat_model.md
index 08afd26..fc34d7e 100644
--- a/website/docs/cmixx/design-specs/threat_model.md
+++ b/website/docs/cmixx/design-specs/threat_model.md
@@ -1,5 +1,5 @@
-# Elixxir Mix Network Threat Model
+# cMixx Network Threat Model
Benjamin Wenger
Richard T. Carback III
diff --git a/website/docs/cmixx/design-specs/wire.md b/website/docs/cmixx/design-specs/wire.md
index 13593ee..f152c4d 100644
--- a/website/docs/cmixx/design-specs/wire.md
+++ b/website/docs/cmixx/design-specs/wire.md
@@ -1,5 +1,5 @@
-# Elixxir mix network wire protocol
+# Wire Protocol
Richard T. Carback III
David Stainton
diff --git a/website/docs/dapps/intro.md b/website/docs/dapps/intro.md
deleted file mode 100644
index ac0d073..0000000
--- a/website/docs/dapps/intro.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# About dApps
-
-dApps are generally 3rd Party applications.
-Support
-Links
-Etc.
\ No newline at end of file
diff --git a/website/docs/dapps/phoenixx.md b/website/docs/dapps/phoenixx.md
index 9a3ca2c..6722e31 100644
--- a/website/docs/dapps/phoenixx.md
+++ b/website/docs/dapps/phoenixx.md
@@ -1 +1,2 @@
-# Phoenixx
\ No newline at end of file
+# Phoenixx
+https://phoenixx.io
\ No newline at end of file
diff --git a/website/docs/dapps/proxxy.md b/website/docs/dapps/proxxy.md
index dd42066..ff58518 100644
--- a/website/docs/dapps/proxxy.md
+++ b/website/docs/dapps/proxxy.md
@@ -1,7 +1,7 @@
# Proxxy
Proxxy is a technology that leverages the xx Network's
-[cMixx](../cmix/cmix.md) network to provide metadata protection
+[cMixx](../cmixx/cmixx.md) network to provide metadata protection
to users of web3.
With Proxxy, any wallet can integrate better privacy, in order to avoid
diff --git a/website/docs/dapps/usecases/test.md b/website/docs/dapps/usecases/test.md
deleted file mode 100644
index e69de29..0000000
diff --git a/website/docs/dapps/xxm.md b/website/docs/dapps/xxm.md
index 9b4e1c7..554555e 100644
--- a/website/docs/dapps/xxm.md
+++ b/website/docs/dapps/xxm.md
@@ -1,6 +1,6 @@
# xx Messenger
-[xx Messenger](https://xxmessenger.io/) is a messaging app originally developed by the Elixxir team. The aim of the team was to use the app as a global test and build out the [xxDK](../cmix/xxdk/overview.md)
+[xx Messenger](https://xxmessenger.io/) is a messaging app originally developed by the Elixxir team. The aim of the team was to use the app as a global test and build out the [xxDK](../category/xxdk)
xx Messgenger is no longer being activly developed but has functioning [Android](https://links.xx.network/playstore) and [iOS](https://links.xx.network/appstore) apps. It can be used "as is" but should not be considered "stable".
diff --git a/website/docs/intro.md b/website/docs/intro.md
index e3482f1..958ea7a 100644
--- a/website/docs/intro.md
+++ b/website/docs/intro.md
@@ -5,9 +5,11 @@ slug: /
# xx network Documentation
-This documentation aims to help understand the core concepts of xx network, its blockchain ([xxChain](xxchain/)) and its communication layer ([cMixx](cmixx/)). You will also find documentation covering advanced topics, end-user tools, use-cases and tutorials.
+This documentation aims to help those interested in xx network to understand the core concepts of xx network, its blockchain ([xxChain](xxchain/)) and its communication layer ([cMixx](cmixx/)). This site also provides deep dives into advanced topics, end-user tools, 3rd party dApps and tutorials.
-As an open-source project, suggesting new topics, adding new content, and providing corrections are welcome. All documentation can be edited via GitLab. If you're unsure how, follow these instructions (TODO).
+:::warning Disclaimer
+This site includes years of documentation from multiple sources, some of which may not represent the current state of things and may require changes and/or additions. These documents are a work-in-progress and are continually evolving.
+:::
# Getting started
@@ -19,5 +21,9 @@ If you are unfamiliar with the xx network start with the ...
* [xxChain](xxchain/xxchain.md) - xxChain specific documentation.
* [cMixx](cmixx/cmixx.md) - cMixx specific documentation.
- * [Tools](tools/) - End-user documentation. (Explorers, Wallets, Staking, Etc.)
- * [dApps](dapps/intro.md) - 3rd Party dApps and Use-cases
+ * [Tools](category/tools/) - End-user documentation. (Explorers, Wallets, Staking, Etc.)
+ * [dApps](category/dapps/) - 3rd Party dApps and Use-cases
+
+:::info How to Contribute
+xx network is a decentralized and open-source project, and we have plans to allow others to submit changes, additions, and corrections via GitLab or GitHub. Please check back again later if you wish to contribute!
+:::
\ No newline at end of file
diff --git a/website/docs/tools/dashboard.md b/website/docs/tools/dashboard.md
index 9988d57..ea2e24d 100644
--- a/website/docs/tools/dashboard.md
+++ b/website/docs/tools/dashboard.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 2
+---
+
# cMixx Dashboard
# [Quick View](https://dashboard.xx.network/)
diff --git a/website/docs/tools/explorer.md b/website/docs/tools/explorer.md
index ad6fd8c..dd91eca 100644
--- a/website/docs/tools/explorer.md
+++ b/website/docs/tools/explorer.md
@@ -1,2 +1,6 @@
+---
+sidebar_position: 1
+---
+
# xxChain Explorer
https://explorer.xx.network
\ No newline at end of file
diff --git a/website/docs/tools/simpleStaking.md b/website/docs/tools/simpleStaking.md
index 9f2dbc3..9ece494 100644
--- a/website/docs/tools/simpleStaking.md
+++ b/website/docs/tools/simpleStaking.md
@@ -1,2 +1,5 @@
+---
+sidebar_position: 4
+---
# Simple Staking
https://staking.xx.network
\ No newline at end of file
diff --git a/website/docs/tools/sleeve.md b/website/docs/tools/sleeve.md
index 1f6c3b2..eea0cae 100644
--- a/website/docs/tools/sleeve.md
+++ b/website/docs/tools/sleeve.md
@@ -1,3 +1,6 @@
+---
+sidebar_position: 3
+---
# Sleeve Wallet Generation Tool
The [Sleeve Wallet Generation Tool](https://sleeve.xx.network/) walks you through the process of creating a quantum-ready wallet for use in the xx Network. It is important that you keep the wallet you generate private and secure, as you would any other cryptocurrency wallet.
@@ -16,7 +19,7 @@ In this step you must input five randomly selected words from the Quantum Mnemon
In this step you must input five randomly selected words from the Standard Mnemonic. As an example you can see "Word #6" is one of the five required to be entered. Word 6 was mercy. After typing in the 5 words correctly, press Next.
## Finish Wallet Setup
-On this page you will see the public address of the generated wallet. At this step you can ["Add Wallet to Accounts"](../webWallet/accounts/addAccount.md) of the Web Wallet using the "Standard Mnemonic" or export a JSON file which can be used to import the account into the Web Wallet.
+On this page you will see the public address of the generated wallet. At this step you can ["Add Wallet to Accounts"](webWallet/accounts/addAccount.md) of the Web Wallet using the "Standard Mnemonic" or export a JSON file which can be used to import the account into the Web Wallet.
## Export JSON Account File
To export the JSON file, enter stong password and press "EXPORT JSON ACCOUNT FILE" button. This file will be saved to local storage of the computer. The password you set here will be asked for if you import the account into the Web Wallet.
diff --git a/website/docs/tools/webWallet/governance/councilElections.md b/website/docs/tools/webWallet/governance/councilElections.md
index 1413f26..32e3bec 100644
--- a/website/docs/tools/webWallet/governance/councilElections.md
+++ b/website/docs/tools/webWallet/governance/councilElections.md
@@ -1,5 +1,5 @@
# Council Elections
-The [Council](../../../chain/governance.md#council) is an on-chain
+The [Council](../../../xxchain/governance.md#council) is an on-chain
representative 13 member body designed to represent passive stakeholders
within the xx network.
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
index 814aafc..672f475 100644
--- a/website/docusaurus.config.js
+++ b/website/docusaurus.config.js
@@ -37,15 +37,15 @@ const config = {
presets: [
[
'classic',
- /** @type {import('@docusaurus/preset-classic').Options} */
+ /** @type {import('@docusaurus/preset-classic').Options} **/
({
docs: {
routeBasePath: '/',
sidebarPath: './sidebars.js',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
- editUrl:
- 'https://git.xx.network/xx_network/node-handbook/-/blob/master/website/',
+ //editUrl:
+ //'https://git.xx.network/xx_network/node-handbook/-/blob/master/website/',
},
blog:false,
/*blog: {
--
GitLab