Skip to content

Commit

Permalink
final review
Browse files Browse the repository at this point in the history
  • Loading branch information
fr1t2 committed Jan 10, 2024
1 parent 2bb59ea commit 5981f4b
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 23 deletions.
3 changes: 1 addition & 2 deletions docs/Build/Fundamentals/whitepaper.md
Expand Up @@ -18,11 +18,10 @@ slug: /build/fundamentals/whitepaper
---


The QRL Whitepaper was developed during the initial development phase of the project back in 2016 by the core developers and cryptographers working on the project.
The QRL Whitepaper was written during the initial development phase of the project back in 2016 by the core developers and cryptographers working on the project.

This paper covers the fundamental building blocks, security decisions and cryptographic functions that make up the core software that governs the core project and blockchain fundamentals.


The whitepaper is hosted on github in multiple language translations and can be found at this link: https://github.com/theQRL/Whitepaper

English direct link: https://github.com/theQRL/Whitepaper/raw/master/QRL_whitepaper.pdf or click on an image below.
Expand Down
14 changes: 7 additions & 7 deletions docs/Build/Messages/message-tx-encoding.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: message-tx-encoding
title: QRL Message Transaction Encoding
hide_title: false
Expand All @@ -17,7 +17,7 @@ image: /assets/img/icons/yellow.png
slug: /build/messages/message-tx-encoding
---

The QRL has instituted a standard for encoding data into the `message_tx` function to differentiate encoded data on the blockchain. This highlights the usage and versatility of on-chain tools like messaging when paired with some additional off chain tooling.
The QRL project has instituted a standard for encoding data into the `message_tx` function to differentiate encoded data on the blockchain. This highlights the usage and versatility of on-chain tools like messaging when paired with some additional off chain tooling.

[QIP002 - *A standard message encoding format to indicate encoded data in MessageTransaction transactions*](https://github.com/theQRL/qips/blob/master/qips/QIP002.md) set the standard for QRL message encoding that's used to differentiate various message types and their functions on the blockchain.

Expand Down Expand Up @@ -58,9 +58,9 @@ The remaining 76 bytes contain any data relevant to the encoded message, and sho

## Supported encoding bytes for specific message type (hex)

- 0000 - reserved
- 0001 - reserved
- 0002 - keybase
- 0003 - github
- 0004 - on-chain voting
- `0000` - reserved
- `0001` - reserved
- `0002` - keybase
- `0003` - github
- `0004` - on-chain voting

2 changes: 1 addition & 1 deletion docs/Build/Messages/notarization-message-encoding.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: notarization-message-encoding
title: QRL Notarization Message Encoding
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/Mining/qrandomx.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: qrandomx
title: QrandomX
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QIP/qip-reference.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: qip-reference
title: QIP Reference
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QIP/qip-specification.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: qip-specification
title: QIP Specification
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QIP/qip-template.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: qip-template
title: QIP Template
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QIP/qip-workflow.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: qip-workflow
title: QIP Workflow
hide_title: false
Expand Down
6 changes: 4 additions & 2 deletions docs/Build/QIP/qip.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: qip-overview
title: QRL Improvement Proposal (QIP)
hide_title: false
Expand All @@ -21,10 +21,12 @@ QRL Improvement Proposals (QIPs) are open proposals put forward to improve the Q

During the process of drafting a QIP, but before the proposal is fully opened, there’s some preliminary discussion held on its specification, implementation and general merits. Some QIPs which are identified as contentious from review of these discussions and community sentiment, will be further put to a vote. Voting is an important aspect of democracy and a way to ensure that the will of the people, including the person reading this, is part of the decision that governs the direction of QRL.

Encouraged ways of participating
**Encouraged ways of participating**

Participate in discussions: The more voices there are in a debate, the more opinions being voiced, the better the understanding of the issue at hand. Your voice also carries weight by having a chance to change peoples minds on the way in which they were to vote.

By being informed: Read this synopsis, but don’t stop there. The synopsis only tries to maintain a the body of discussions that have taken place. Continue to read the opinions of others and research into things you’re unsure about.

Finally, Vote: Every vote counts. Don’t feel discouraged if you see the vote going another way & be vote anyway!

## QIPs
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QRL-Helpers/explorer-helpers.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: explorer-helpers
title: QRL Explorer Helpers
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QRL-Helpers/node-helpers.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: node-helpers
title: QRL Node Helpers
hide_title: false
Expand Down
2 changes: 1 addition & 1 deletion docs/Build/QRL-Helpers/validate-qrl-address.md
@@ -1,5 +1,5 @@
---
docstatus: 30%
docstatus: 90%
id: validate-qrl-address
title: Validate QRL Address
hide_title: false
Expand Down
6 changes: 3 additions & 3 deletions sidebars.js
Expand Up @@ -488,7 +488,7 @@ const sidebars = {
link: {
type: 'generated-index',
title: 'QRL Fundamental Topics',
description: 'Covering general topics related to the QRL',
description: 'Covering some fundamental topics related to the QRL',
slug: '/build/fundamentals',
keywords: ['learn'],
image: '/assets/img/icons/yellow.png',
Expand All @@ -507,7 +507,7 @@ const sidebars = {
link: {
type: 'generated-index',
title: 'QRL Message Encoding Documentation',
description: 'Message encoding standard for the QRL Message Transactions',
description: 'Message encoding standard for the various QRL Message Transaction types',
slug: '/build/messages',
keywords: ['learn'],
image: '/assets/img/icons/yellow.png',
Expand Down Expand Up @@ -566,7 +566,7 @@ const sidebars = {
link: {
type: 'generated-index',
title: 'QRL Code Libraries and helpers',
description: 'Main QRL node CLI tools and usage.',
description: 'Various helper scripts developed to aid and assist in developing on the QRL.',
slug: '/developers/helpers',
keywords: ['qrl-helpers', 'node-helpers'],
image: '/assets/img/icons/yellow.png',
Expand Down

0 comments on commit 5981f4b

Please sign in to comment.