Indigo - Doc suggestions (#59)

* docs: update RBS page * bonds * staking * wip * new structure wip * flesh out technical docs * cleanup. close to finish * small cleanup, fix build * fix: adjust intro page and contract overview * flex loan page and audits * nuke old website links - they need updating * add back migration link -- it needs updating for the new ui too Co-authored-by: Oighty <[email protected]> Co-authored-by: appleseed-iii <[email protected]> Co-authored-by: Applebee's <[email protected]>
OlympusDAO · Dec 5, 2022 · bcb7eed · bcb7eed
1 parent 1fabfea
commit bcb7eed
Show file tree

Hide file tree

Showing 92 changed files with 13,652 additions and 512 deletions.
diff --git a/docs/basics/bonding.md b/docs/basics/bonding.md
diff --git a/docs/basics/bophades.md b/docs/basics/bophades.md
diff --git a/docs/basics/inverse-bonds.md b/docs/basics/inverse-bonds.md
diff --git a/docs/basics/migration.md b/docs/basics/migration.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 8
----
-
 # V2 Migration
 
 ## Why do I need to migrate?

diff --git a/docs/basics/readme.md b/docs/basics/readme.md
diff --git a/docs/contracts/allocators.md → docs/contracts-old/allocators.md b/docs/contracts/allocators.md → docs/contracts-old/allocators.md
diff --git a/docs/contracts/audits.md → docs/contracts-old/audits.md b/docs/contracts/audits.md → docs/contracts-old/audits.md
diff --git a/docs/contracts/bonds.md → docs/contracts-old/bonds.md b/docs/contracts/bonds.md → docs/contracts-old/bonds.md
diff --git a/docs/contracts/dao.md → docs/contracts-old/dao.md b/docs/contracts/dao.md → docs/contracts-old/dao.md
diff --git a/docs/contracts/equations.md → docs/contracts-old/equations.md b/docs/contracts/equations.md → docs/contracts-old/equations.md
diff --git a/docs/contracts/glossary.md → docs/contracts-old/glossary.md b/docs/contracts/glossary.md → docs/contracts-old/glossary.md
diff --git a/docs/contracts/interactions.md → docs/contracts-old/interactions.md b/docs/contracts/interactions.md → docs/contracts-old/interactions.md
diff --git a/docs/contracts/interactions.mmd → docs/contracts-old/interactions.mmd b/docs/contracts/interactions.mmd → docs/contracts-old/interactions.mmd
diff --git a/docs/contracts/interactions.svg → docs/contracts-old/interactions.svg b/docs/contracts/interactions.svg → docs/contracts-old/interactions.svg
diff --git a/docs/contracts/policy.md → docs/contracts-old/policy.md b/docs/contracts/policy.md → docs/contracts-old/policy.md
diff --git a/docs/contracts/range-bound-stability.md → docs/contracts-old/range-bound-stability.md b/docs/contracts/range-bound-stability.md → docs/contracts-old/range-bound-stability.md
diff --git a/docs/contracts/staking.md → docs/contracts-old/staking.md b/docs/contracts/staking.md → docs/contracts-old/staking.md
diff --git a/docs/contracts/tokens.md → docs/contracts-old/tokens.md b/docs/contracts/tokens.md → docs/contracts-old/tokens.md
diff --git a/docs/contracts/treasury.md → docs/contracts-old/treasury.md b/docs/contracts/treasury.md → docs/contracts-old/treasury.md
diff --git a/docs/governance/index.md → docs/governance/00_dao.md b/docs/governance/index.md → docs/governance/00_dao.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+slug: /governance/dao
 ---
 
 # Governance & DAO

diff --git a/docs/governance/council.md → docs/governance/01_council.md b/docs/governance/council.md → docs/governance/01_council.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 2
----
-
 # Council
 
 All proposals, whether being consistent with the general direction of the DAO, a change in policy, or a pivot to a certain strategy or framework are voted for by the community. Any member of the community can create a proposal on the forum for discussion before being posted to snapshot for a governance vote. [Olympus Governance Council (OGC)](https://forum.olympusdao.finance/d/1156-oip-91-olympus-governance-council) will be initially comprised of 7 veteran community members who are primarily responsible for facilitating off-chain processes. These can include, but are not limited to, establishing strategic vision, coordinating working groups to execute on community-approved initiatives, and proposing strategic initiatives to the community via OIP.

diff --git a/docs/governance/policy.md → docs/governance/02_policy.md b/docs/governance/policy.md → docs/governance/02_policy.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 3
----
-
 # Policy Team & Policy Framework
 
 The policy team is composed of about 20 members of the Olympus community who have displayed sufficient knowledge of the protocol and a curiosity to continue to learn as the protocol grows in size and complexity. Policy is largely guided by the [policy framework](https://forum.olympusdao.finance/d/622-oip-56-olympusdao-policy-framework-v2).

diff --git a/docs/governance/treasury-process.md → ...e/03_dao-processes/00_treasury-process.md b/docs/governance/treasury-process.md → ...e/03_dao-processes/00_treasury-process.md
diff --git a/docs/governance/policy-process.md → ...nce/03_dao-processes/01_policy-process.md b/docs/governance/policy-process.md → ...nce/03_dao-processes/01_policy-process.md
diff --git a/docs/governance/grant-process.md → ...ance/03_dao-processes/02_grant-process.md b/docs/governance/grant-process.md → ...ance/03_dao-processes/02_grant-process.md
diff --git a/docs/governance/03_dao-processes/_category_.json b/docs/governance/03_dao-processes/_category_.json
@@ -0,0 +1,5 @@
+{
+	"label": "DAO Process",
+	"position": 3,
+	"collapsed": true
+}
diff --git a/docs/literature-content/papers.md b/docs/literature-content/papers.md
diff --git a/docs/overview/00_intro.md b/docs/overview/00_intro.md
@@ -0,0 +1,14 @@
+
+# What is Olympus Protocol?
+
+Olympus is a protocol on the Ethereum blockchain with the goal of establishing OHM as a crypto-native reserve currency. It conducts autonomous and dynamic monetary policy, with market operations supported by the protocol-owned Olympus Treasury.
+
+OHM serves a need in the market gap between fiat stablecoins and volatile crypto assets, providing relative stability and scalability underpinned by the protocol’s Range Bound Stability (“RBS”) system. RBS is the flagship system of Olympus’ autonomous monetary policy.
+
+## What are reserve currencies designed to achieve?
+
+* Deep liquidity: reserve currencies are highly liquid and can be easily exchanged for other assets, products and services
+* Serve  as a unit of account: Other assets are denominated in the currency
+* Preserve purchasing power: Provides its holders a stable, low volatility asset that grows at a steady rate over the medium-to- long-term.
+
+Olympus DAO’s efforts in Treasury management, development of on-chain governance structures and prudent use of Olympus’ liquidity and Treasury assets will help to strengthen OHM’s stability to usher in the growth of the Olympus network economy.
diff --git a/docs/basics/staking.md → docs/overview/01_staking.md b/docs/basics/staking.md → docs/overview/01_staking.md
@@ -1,13 +1,9 @@
----
-sidebar_position: 1
----
-
 # Staking
 
-OHM holders can choose to stake OHM for gOHM, which receives the Base Staking Rate (“BSR”). During Olympus’ bootstrapping phase, this rate was intended to reflect the expected growth of the network. The BSR now serves as a demand driver for OHM as well as a reference rate against which productive economic activity (lending, liquidity provision, etc.) is measured. Furthermore, it acts as a foundation for OHM bonds to develop a yield curve across different expiries. 
+OHM holders can choose to stake OHM for gOHM, which receives the Base Staking Rate (“BSR”). During Olympus’ bootstrapping phase, this rate was intended to reflect the expected growth of the network. The BSR now serves as a demand driver for OHM as well as a reference rate against which productive economic activity (lending, liquidity provision, etc.) is measured. Furthermore, it acts as a foundation for OHM bonds to develop a yield curve across different expiries.
 
 The BSR is set by governance.
 
-$$
-gOHM = OHM*Index
-$$
+    gOHM = OHM * Index
+
+where `Index` is an increasing number based on the BSR.