Merge pull request #22 from jackalyst/main

Cleanup & minor fixes before final documentation push

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 The Quantum Resistant Ledger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/API/wallet-api.md

@@ -263,7 +263,7 @@ Using default settings this will generate a new address with:
 The newly generated address will be added to the `~/.qrl/walletd.json` file. This file will be created if it does not already exist.
 
 :::note
-Ensure the tree height is large enough for your needs and transfer all funds out of the address before all [OTS keys](build/fundamentals/ots-keys) are used!
+Ensure the tree height is large enough for your needs and transfer all funds out of the address before all [OTS keys](/build/fundamentals/ots-keys) are used!
 :::
 
 <Tabs
@@ -1981,7 +1981,7 @@ Send up to 80 bytes of message data onto the chain.
 Send message data onto the chain. Allows up to 80 Bytes of data to be sent onto the QRL blockchain.
 
 :::info Message Encoding
-For more information on the QRL Message Encoding please see the [Message documentation](build/messages)
+For more information on the QRL Message Encoding please see the [Message documentation](/use/tools/messages/overview)
 :::
 
 <Tabs
@@ -2900,7 +2900,7 @@ This method will transfer tokens held in a QRL Address in the local wallet. Usin
 :::note
 To find all addresses held by an address use the [QRL Block Explorer](https://explorer.theqrl.org) to look up the address and list all tokens held. 
 
-Additionally you can use another API to lookup the address details and tokens held by address. For instance the [GetTokensByAddresss Method](api/qrl-public-api#gettokensbyaddress) will return a list of tokens held by that address.
+Additionally you can use another API to lookup the address details and tokens held by address. For instance the [GetTokensByAddresss Method](/api/qrl-public-api#gettokensbyaddress) will return a list of tokens held by that address.
 :::
 
 :::info Requires token transaction hash

docs/Build/Address/slaves.md

@@ -31,7 +31,7 @@ Slave addresses are advanced and are not usually needed for most users!
 
 ## Overview
 
-A slave key is generated using the [QRL command line tools](use/node/node-cli/node-cli-slave-xmss) or via the API.
+A slave key is generated using the [QRL command line tools](/use/node/node-cli/node-cli-slave-xmss) or via the API.
 
 This process is similar to generating a QRL address and will output a slaves.json file which contains the private keys for each slave generated (Up to 100).
 

docs/Build/Fundamentals/qrl-emission.md

@@ -62,7 +62,7 @@ $b=Z_{t-1}-Z_t$
 
 The QRL emission schedule, or amount of quanta generated with each block mined, was updated in QIP-16 (*QRL Improvement Proposal*) through a public on-chain vote to reduce the total reward each block paid out by a factor of 60%. 
 
-You can read more about the [QIP process here](build/qip/overview), and review the history of this QIP in the GitHub repository.
+You can read more about the [QIP process here](/build/qip/overview), and review the history of this QIP in the GitHub repository.
 
 
 

docs/Tutorials/Node/mainnet-testnet-node.md

@@ -150,7 +150,7 @@ qrl --json --port_pub 19019 state
 From this output you can see the testnet node is running, the blockheight is different form the mainnet node running and the networkID is different.
 
 :::tip 
-Check the node blockHeight against the [QRL Testnet Explorer](https:testnet-explorer.theqrl.org)
+Check the node blockHeight against the [QRL Testnet Explorer](https://testnet-explorer.theqrl.org)
 :::
 
 ## Final Thoughts

docs/Tutorials/Wallet/generate-address-dice.md

@@ -18,11 +18,6 @@ image: /assets/img/icons/yellow.png
 slug: /tutorials/wallet/generate-address-dice
 ---
 
-:::caution DOCUMENT STATUS 
-<span>This document is in: <b>{frontMatter.docstatus}</b> status and needs additional input!</span>
-:::
-
-
 For those who are completely paranoid about random number generation, it is possible to create entropy for a seed or mnemonic by rolling a dice. 
 
 The more sides the dice has the more bits of entropy may be gathered with each roll, resulting in fewer rolls to complete a mnemonic.

docs/Use/Node/node-cli/node-cli-slave-xmss.md

@@ -22,13 +22,10 @@ slug: /use/node/node-cli/node-cli-slave-xmss
 
 The QRL wallet is an XMSS Merkle tree constructed using the private key to generate leaves. Each "leaf" can also generate a tree of OTS Slave keys that can be used to sign transactions. This allows further expansion of a QRL wallet extending the number of transactions you can process before needing to regenerate a new wallet.
 
-> To create a slaves.json file you will need a QRL wallet.json file and a working installation of QRL. See the guide for creating a [QRL CLII Wallet](use/node/node-cli/overview)
-{: .info}
+> To create a slaves.json file you will need a QRL wallet.json file and a working installation of QRL. See the guide for creating a [QRL CLI Wallet](/use/node/node-cli/overview)
 
 Currently the only way to generate a slaves.json file is by using the command line utility `qrl`. This can be installed by following the [QRL Node Guide](/use/node).  You will need to have shell access and be logged into the computer running qrl.
 
-
-
 ## Create a Slaves.json
 
 To generate a slaves.json file you will need to be connected to an active and synced node. This can be a local node, as well any of the peers shown in your nodes peer list. You also need a wallet to use for the slaves file.

docs/Use/Tools/notarize/notarization.md

@@ -31,7 +31,7 @@ Once notarized, any exact copy of that document can be cryptographically verifie
  ## Advanced users
 
 :::note
-There are multiple ways to access the notarization process through the [QRL API](/api) and [Command Line Tools](use/node/node-cli/overview) using the `message_tx` with appropriate [message encoding](/build/messages/message-tx-encoding).
+There are multiple ways to access the notarization process through the [QRL API](/api) and [Command Line Tools](/use/node/node-cli/overview) using the `message_tx` with appropriate [message encoding](/build/messages/message-tx-encoding).
 :::
 
 

docs/Use/Tools/notarize/verify-data.md

@@ -25,7 +25,7 @@ Use our Document Notarization guide to get started with on-chain quantum resista
 
 ## Document Verification
 
-Browse to the [QRL Block Explorer](https:explorer.theqrl.org) and lookup the transaction hash from the initial document notarization.
+Browse to the [QRL Block Explorer](https://explorer.theqrl.org) and lookup the transaction hash from the initial document notarization.
 
 You can either save the tx_hash from the original transaction or simply lookup the QRL address used to send the notarization.
 

docs/Use/Wallet/Ledger/new-wallet.md

@@ -19,7 +19,7 @@ slug: /use/wallet/ledger/new
 
 ## Installing the QRL App
 
-Using the [Ledger Live](https://www.ledger.com/pages/ledger-live) application, [follow these instructions](https://support.ledger.com/hc/en-us/articles/360019184453?support=true:
+Using the [Ledger Live](https://www.ledger.com/ledger-live) application, [follow these instructions](https://support.ledger.com/hc/en-us/articles/360019184453?support=true):
 
 1. Open the **Manager** in Ledger Live
 2. **Connect and Unlock** your Ledger Nano

docs/Use/Wallet/Ledger/open-ledger-wallet.md

@@ -39,5 +39,5 @@ Chrome users, there is a bug with chrome that will not allow the Ledger to work.
 :::
 
 :::info Firefox Connection Issues
-If you are a Firefox user, ensure you have enabled **u2f** before proceeding. [Enabling U2F support in Mozilla Firefox](https://support.yubico.com/support/solutions/articles/15000017511-enabling-u2f-support-in-mozilla-firefox)
+If you are a Firefox user, ensure you have enabled **u2f** before proceeding. [Enabling U2F support in Mozilla Firefox](https://www.key-id.com/enable-fido-u2f-firefox/)
 :::

docs/getting-started.md

@@ -21,11 +21,16 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 
+:::info QRL Zond Documentation
+See [test-zond.theqrl.org](https://test-zond.theqrl.org) to try our new cutting edge Proof-of-Stake network with EVM smart contracts.
+:::
 
 Welcome to the Quantum Resistant Ledger documentation! These doc's aim to be the central source of information for the QRL for all topics from using the base tools to building on the project. Whether you are developing a new project or simply understanding the basics this is the source.
 
 The docs are broken into 3 main categories, [Use](/use), [Build](/build) , and [API](/api). These sections aim to guide a users, developers, and everyone in between through the project from basic functionality into more advanced topics like API usage and Extended XMSS HyperTree creation.
 
+
+
 ---
 
 <Tabs defaultValue="use" 
@@ -211,12 +216,4 @@ The docs are broken into 3 main categories, [Use](/use), [Build](/build) , and [
 
 :::info MORE QUESTIONS?
 If you don't find all you need from these docs, please join us in our [Discord Server](https://theqrl.org/discord) for more direct help.
-:::
-
-:::caution DOCUMENT STATUS
-**Contributions welcome and appreciated!**
-
-<span> This site is in <i>{frontMatter.docstatus}</i> status and needs additional input and work! </span>
-
-<span>Use the links to edit any document in Github, sign in and make your changes. For in-depth contributions, fork the <a href="https://github.com/theqrl/documentation">documentation repo</a> and branch your changes to get started, or see us in the <a href="https://theqrl.org/discord">QRL Discord server. </a></span>
-:::
+:::

docusaurus.config.js

@@ -240,7 +240,7 @@ const config = {
             ],
           },
           {
-            href: 'https://github.com/facebook/docusaurus',
+            href: 'https://github.com/theQRL/',
             label: 'GitHub',
             position: 'right',
           },
@@ -276,16 +276,16 @@ const config = {
             title: 'Community',
             items: [
               {
-                label: 'Stack Overflow',
-                href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+                label: 'Discord',
+                href: 'https://www.theqrl.org/discord',
               },
               {
-                label: 'Discord',
-                href: 'https://discordapp.com/invite/docusaurus',
+                label: 'Telegram',
+                href: 'https://www.theqrl.org/telegram',
               },
               {
                 label: 'Twitter',
-                href: 'https://twitter.com/docusaurus',
+                href: 'https://twitter.com/QRLedger',
               },
             ],
           },
@@ -294,7 +294,7 @@ const config = {
             items: [
               {
                 label: 'GitHub',
-                href: 'https://github.com/facebook/docusaurus',
+                href: 'https://github.com/theQRL/',
               },
             ],
           },

package.json

@@ -2,6 +2,7 @@
   "name": "docs-theqrl-org",
   "version": "0.0.0",
   "private": true,
+  "license": "MIT",
   "scripts": {
     "docusaurus": "docusaurus",
     "start": "docusaurus start",