From f895a1673130b34e00bbac1de29fe07a29407941 Mon Sep 17 00:00:00 2001 From: Jack Hodgkinson <30505104+jhodgdev@users.noreply.github.com> Date: Wed, 26 Jan 2022 14:45:49 +0000 Subject: [PATCH] minor changes --- docs/README.md | 23 ++++++++++++++++++----- docs/meta/style-guide.md | 19 +++++++++++++------ 2 files changed, 31 insertions(+), 11 deletions(-) diff --git a/docs/README.md b/docs/README.md index 51650fa..2140611 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,18 +1,31 @@ -# Agora specification & documentation +| Spec Status | Impl Status | Last Revision | +|-------------|----------------|---------------| +| WIP | WIP | v0.1 22/01/26 | -This folder contains all of the specification and architecture documentation of agora. +-------------------- + +**Spec Ownership:** [Jack Hodgkinson](github.com/jhodgdev) + +**Authors**: [Jack Hodgkinson](github.com/jhodgdev) + +**Current Status**: + +-------------------- +# Agora specification and documentation + +This folder contains all of the specification and architecture documentation of Agora. ## Technical design -The `tech-design/` subdirectory contains high level description of architecture involved in building agora's governance system. +The `tech-design/` subdirectory contains high level descriptions of architecture involved in building Agora's governance system. ## Implementation -Agora makes extensive use of plutarch. So it's prerequisite for understanding the implementation. Plutarch features an [_extensive_ guide](https://github.com/Plutonomicon/plutarch/blob/master/docs/GUIDE.md), which explains many intricacies of plutarch and its use. +Agora makes extensive use of Plutarch. So it's prerequisite for understanding the implementation. Plutarch features an [_extensive_ guide](https://github.com/Plutonomicon/plutarch/blob/master/docs/GUIDE.md), which explains many intricacies of Plutarch and its use. ## Glossary -The following is a list of words/shorthands that are frequently used: +The following is a list of terms that are used frequently: - **Governance Token (GT)**: The token that holds value within the protocol and is used for voting, rewards, etc. _Examples: Liqwid's LQ_. - **Authority Token (GAT)**: A token that delegates authority of a particular script / token. See [tech-design/authority-token.md](./tech-design/authority-tokens.md) diff --git a/docs/meta/style-guide.md b/docs/meta/style-guide.md index 92a5ea2..ae99b7c 100644 --- a/docs/meta/style-guide.md +++ b/docs/meta/style-guide.md @@ -3,16 +3,23 @@ This document includes a couple of notes on how Agora documentation should be written and formatted. ## Capitalised words + The following words should always be render capitalised: -- Agora -- Plutus -- Plutarch -- Liqwid -- LiqwidX +- Agora +- Plutus +- Plutarch +- Liqwid +- LiqwidX ## Lower-case words + The following words should always be rendered lower-case: -- governance +- governance +## Avoid + +The following practices should be avoided: + +- The use of '&' e.g. 'specification and documentation' vs 'specification & documentation'.