Sulkta-OSS/agora
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

init docs

Browse source
This commit is contained in:
Emily Martins 2022-01-18 17:46:06 +01:00
parent c40e6e9f36
commit e201b5e6d7
3 changed files with 136 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/README.md Normal file
View file

@ -0,0 +1,18 @@
# agora specification & 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.
## 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.
## Glossary
The following is a list of words/shorthands that are frequently used:
- **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](..)