ac8f70a174
Leaving some comments/questions from my first read-through (starting in alphabetical order in `tech-design`). I'll probably have answered most of these by the time I'm finished going through all the docs, but it will do us well to make this as easy to read straight through as possible. General comments: ----- - It'd be good to pick an entry-point/give an overview in the README. This way you can keep track of when different concepts are introduced, and contributors to the spec will have a better idea of what they can assume their audience knows. - These docs are Liqwid-centric (and I believe I've skimmed earlier versions in the `liqwid-specs` repo) right now. We should decide whether we want to keep these specs focused on Liqwid, or if it would make sense to build up a small, hypothetical, minimum-viable-example that gets extended with Agora. The benefits of the former are that you can point to a real-world example of Agora's principles and implementation in practice; the latter could be more useful in a "here's how to integrate Agora into a project" tutorial |
||
|---|---|---|
| .. | ||
| diagrams | ||
| tech-design | ||
| README.md | ||
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, 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
- Effect: The result of a proposal, enforced by an effect script.