minor changes
This commit is contained in:
parent
cb7356e775
commit
f895a16731
2 changed files with 31 additions and 11 deletions
|
|
@ -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
|
## 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
|
## 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
|
## 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_.
|
- **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)
|
- **Authority Token (GAT)**: A token that delegates authority of a particular script / token. See [tech-design/authority-token.md](./tech-design/authority-tokens.md)
|
||||||
|
|
|
||||||
|
|
@ -3,16 +3,23 @@
|
||||||
This document includes a couple of notes on how Agora documentation should be written and formatted.
|
This document includes a couple of notes on how Agora documentation should be written and formatted.
|
||||||
|
|
||||||
## Capitalised words
|
## Capitalised words
|
||||||
|
|
||||||
The following words should always be render capitalised:
|
The following words should always be render capitalised:
|
||||||
|
|
||||||
- Agora
|
- Agora
|
||||||
- Plutus
|
- Plutus
|
||||||
- Plutarch
|
- Plutarch
|
||||||
- Liqwid
|
- Liqwid
|
||||||
- LiqwidX
|
- LiqwidX
|
||||||
|
|
||||||
## Lower-case words
|
## Lower-case words
|
||||||
|
|
||||||
The following words should always be rendered lower-case:
|
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'.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue