diff --git a/docs/basics/bonding.md b/docs/basics/bonding.md index cda1ef6..9b1d442 100644 --- a/docs/basics/bonding.md +++ b/docs/basics/bonding.md @@ -2,16 +2,14 @@ sidebar_position: 3 --- -# Bonding +# Bonds -Olympus bonds are a financial primitive for protocols to acquire assets, including their own liquidity, in exchange for governance tokens at a discount. In other words, Olympus bonds are a pricing mechanism for any two ERC-20 tokens that does not rely on third parties like oracles. Olympus bonds internally respond to supply and demand by offering a variable ROI rate to the market and its users. +Olympus bonds are a financial primitive for protocols to acquire assets, including their own liquidity, over a specified time in exchange for tokens upon maturity. In other words, Olympus bonds are a pricing mechanism for any two ERC-20 tokens that does not rely on third parties like oracles. -## How do both the Olympus Treasury and the bonder benefit from the process? +External Bonds are an application of this primitive, which sells OHM at a discount to acquire Treasury assets. External Bonds represent the primary mechanism for Olympus Treasury inflows. -Bonds are the primary mechanism for Treasury inflows, and thus, the growth of the network. +When purchasing a bond, purchasers commit a capital sum upfront in return for OHM upon maturity. Thus, a bond’s profit is uncertain and dependent on the price of OHM at the time of maturity. -Bonders commit a capital sum upfront and are promised a fixed return at a set point in time; that return is in OHM and thus the bonder's profit would depend on OHM price when the bond matures. In Olympus v2, users who bond their assets for OHM reap the same benefits as stakers as OHM is automatically staked at the time of a bond purchase. +When viewing a current bond offering, a positive discount indicates that the bond is currently offering OHM at a discount to its current market price. A negative discount indicates that the bond is currently offering OHM at a premium to its current market price. -If the ROI is positive – a bond can be purchased at a discount to market price) – market participants (bonders) are incentivized to exchange their assets for gOHM, vested over a period of time. The Treasury sells OHM at a premium to its backing, while the bonder is able to capture a discount (positive ROI) by purchasing OHM directly from the Treasury. However, if the variable ROI is negative, and market participants are unable to express their demand on the bond marketplace, they would have to resort to a decentralized exchange. - -The variable ROI rate is at the one hand determined by the demand for the given bond on the Olympus bond marketplace, and on the other hand it is governed by the policy team which sets the BCV which determines the bond capacity. In exchange for being temporarily illiquid, and exposed to OHM/gOHM volatility for the duration of the vesting period, the bonder is rewarded with a variable ROI rate. \ No newline at end of file +This variable discount rate is how a bond market internally governs its supply by responding to demand. This ensures that a bond market’s supply is sold over the specified period of time. diff --git a/docs/basics/bophades.md b/docs/basics/bophades.md new file mode 100644 index 0000000..39b1e76 --- /dev/null +++ b/docs/basics/bophades.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Bophades / Default + +Default framework explanation diff --git a/docs/basics/readme.md b/docs/basics/readme.md index 264bdeb..56c70d4 100644 --- a/docs/basics/readme.md +++ b/docs/basics/readme.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -sidebar_label: "What is Olympus?" +sidebar_label: "Basics" slug: /basics/readme --- @@ -8,63 +8,12 @@ slug: /basics/readme ## What is Olympus? -The goal of the Olympus protocol is to create a decentralized, censorship resistant reserve currency for the emerging Web3 ecosystem. Developing a reserve currency is important because a fundamental goal of the Web3 financial movement is to foster an alternative economic ecosystem that serves the needs of its various stakeholders, which include: +Olympus is a distributed protocol on the Ethereum blockchain with the goal of establishing OHM as a reserve currency of DeFi. It operates thanks to its autonomous and dynamic monetary policy, with market operations supported by the Olympus Treasury as a core component of the protocol. -* Having access to unique purpose-built assets that are widely and uniformly available across L1s and L2s -* Being able to transact/store value in highly decentralized and censorship-resistant assets that are not dependent on the traditional financial ecosystem for validation or survival +What are reserve currencies designed to achieve? +Preserving purchasing power: Over the medium- to long-term the asset grows to out-pace inflation, and becomes more stable over time +Deep liquidity: Reserve currencies are highly liquid and can be easily exchanged for other assets, products and services +Utilized as a unit of account: Other assets are denominated in the currency -
- -
-## What is OHM? - -Olympus’s goal is to create a credibly neutral currency for Web3 and to help onboard users into a decentralized, democratized economy, with the additional goal of becoming the reserve currency for DeFi. - -What are reserve currencies designed to achieve? - -* Preserving purchasing power: Over the medium- to long-term the asset grows to out-pace inflation, and becomes more stable over time -* Deep liquidity: Reserve currencies are highly liquid and can be easily exchanged for other assets, products and services -* Utilized as a unit of account: Other assets are denominated in the currency -* Reserve assets serve as trusted backing: The currency is viewed as reliable and relatively low risk, which encourages entities to hold large quantities of it in reserve - -Currently, Olympus is early on its journey to secure OHM’s status as a decentralized reserve currency. The Olympus12 Action Plan outlines the concrete steps the DAO is taking to make this vision a reality in 2022, including making OHM as automated and governance-minimized as possible. - -## Why is there a need for a reserve currency in DeFi? - -In contrast to the incumbent fiat system that’s declining in value due to inflation, our goal is to build and retain real purchasing power that withstands the test of time. 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. - -## How does Olympus operate? - -Olympus is run by OlympusDAO. - -OlympusDAO is a network of dedicated community members who execute on decisions & protocol mechanisms voted on through community governance. - -Our eventual goal is to build an autonomous system at the protocol level, in which the behavior of OHM is largely influenced by decentralized smart contracts and with minimal human intervention. - -The DAO is pursuing a strategy of “progressive decentralization.” Currently, major components of the protocol are controlled at a high-level by the DAO. Though, ultimately the focus is on creating a foundation at the Treasury, Policy and economic levels, and to enable the community to directly operate protocol mechanics – in a trust- and process-minimized fashion. - -## Governance - -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. - -Key deliverables for the OGC include: - -* Drive prioritization and alignment across the DAO departments and working groups -* Chart a path to further decentralized DAO governance and operations -* Oversee the broader econOHMy - -## 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) - -Policy closely monitors the behavior of the protocol and utilizes the powers assigned to them in the policy framework to actively manage the protocol. Policy is committed to help bring inflows into the treasury, and continue to increase OHM's relative backing, and helping Olympus to continue developing products and services that grow the Olympus economy. - -## Who created Olympus? - -Olympus was ideated by Zeus and built by a distributed pseudo-anonymous team. +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 blockchain network economy. diff --git a/docs/basics/staking.md b/docs/basics/staking.md index 944c985..7a745d2 100644 --- a/docs/basics/staking.md +++ b/docs/basics/staking.md @@ -4,49 +4,12 @@ sidebar_position: 2 # Staking -Staking is the primary value accrual strategy of Olympus. Stakers stake their OHM on the Olympus website to earn rebase rewards. The rebase rewards are minted every 2200 Ethereum blocks (8 hours) as long as there is a corresponding equivalent of 1 DAI in the Treasury to back it. This is guaranteed on the smart-contract level. +Olympus leverages the staking mechanism to organize the capital within the network ($OHM) around economic activity which is productive for both the protocol treasury and OHM holders, with the Olympus Treasury being one of the largest OHM holders. -Runway displays the number of days Olympus would maintain its current rate of emissions without any inflows to the Treasury or changes to the reward rate. -Staking is a passive, long-term strategy. The increase in your stake of OHM translates into a constantly falling cost basis converging on zero. This means even if the market price of OHM drops below your initial purchase price, given a long enough staking period, the increase in your staked OHM balance should eventually outpace the fall in price. +Olympus is able to, either directly or indirectly, incentivize different modes of economic activity that help manage risk to the protocol and treasury as a part of its evolving and autonomous monetary policy. -When you stake, you lock OHM and receive an equal amount of sOHM. Your sOHM balance rebases up automatically at the end of every epoch. sOHM is transferable and therefore composable with other DeFi protocols. +***Base Staking Rate [TBD?]*** -When you unstake, you burn sOHM and receive an equal amount of OHM. Unstaking means the user will forfeit the upcoming rebase reward. Note that the forfeited reward is only applicable to the unstaked amount; the remaining staked OHM (if any) will continue to receive rebase rewards. - -## What is the benefit of staking OHM? - -By staking their OHM, users opt in to actively participate in the Olympus network, and become eligible participants in governance. By participating in the network, stakers benefit from a rebasing mechanism that ensures their position scales with OHM emissions and overall the growth of the network. - -Every 8 Hours (2200 Ethereum Blocks) the protocol uses two mathematical formulas to calculate the network wide distribution. +Base Staking Rate functions as a base incentive to hold OHM, helps to drive demand, and acts as a reference rate for emerging lending markets. Furthermore, it acts as a foundation for OHM bonds to develop a yield curve across different expiries. ![sOHM/gOHM explainer](/gitbook/assets/sohmgohm.png) - -## What is the relationship between staking and reward rate? - -The level of OHM staking rewards is determined by the overall reward rate, and was codified by the community (via the OIP-18 vote). The reward yield, which is a function of reward rate, is also dependent on how many other individuals are staking their OHM. When more individuals are staking the reward yield declines and the opposite occurs when the reward rate increases. - -Olympus presents our current sOHM (staked OHM) reward yield as an illustrative annual percentage yield (APY) on our app. We do this because sOHM rebases several times a day (about every 8 hours). Given this, rebases have an effect analogous to compounding interest. - -The APYs presented by Olympus are a representation of the current rebase rate, number of stakers and existing supply. These calculations are floating and the current rates are not a guarantee of future returns. - -The APY is calculated from the reward yield \(a.k.a rebase rate\) using the following equation: - -$$ -APY = ( 1 + rewardYield )^{1095} - 1 -$$ - -It raises to the power of 1095 because a rebase happens 3 times daily. Consider there are 365 days in a year, this would give a rebase frequency of 365 \* 3 = 1095. - -Reward yield is determined by the following equation: - -$$ -rewardYield = OHM_{distributed} / OHM_{totalStaked} -$$ - -The number of OHM distributed to the staking contract is calculated from OHM total supply using the following equation: - -$$ -OHM_{distributed} = OHM_{totalSupply} \times rewardRate -$$ - -Note that the reward rate is subject to change by the protocol. \ No newline at end of file diff --git a/docs/basics/treasury.md b/docs/basics/treasury.md deleted file mode 100644 index d6ee20a..0000000 --- a/docs/basics/treasury.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -sidebar_position: 4 ---- -# Treasury - -For Olympus, the Treasury is a key function of the protocol. The Treasury represents all assets owned and controlled by the protocol. This is also known as Protocol Controlled Value (PCV). The Treasury defines a few internal classifications, and all of them combined represent the budget for various market operations, or the ability to influence OHM. - -* Treasury Reserves, represented per token as liquid backing, this represents a total budget Olympus has for various market operations. -* Protocol owned liquidity – Deep liquidity is one of the central pillars that make a reserve currency. Liquidity owned by the protocol is a guarantee a liquid market facilitating exchange in both directions exists. -* Locked, vesting, or other strategic assets - -## Protocol-owned liquidity (POL) - -The concept of POL is an attempt to solve bootstrapping liquidity while avoiding the cost of paying self-interested external liquidity providers – mercenary capital. Rather than renting, Olympus owns its own liquidity. - -Without being reliant on external liquidity providers, Olympus can guarantee a liquid market for OHM while establishing a revenue stream from LP fees for the Treasury. - -All protocol liquidity adds towards OHM backing – the LP tokens are marked down to their risk-free value for this purpose. You can read more about the rationale behind here. - -While Olympus’ POL will always remain crucial to its goal of being a reserve currency, as it matures it will be equally as important to have other market participants who share aligned interests help to make OHM more easily accessible across different exchanges and platforms. \ No newline at end of file diff --git a/docs/governance/council.md b/docs/governance/council.md new file mode 100644 index 0000000..b981e44 --- /dev/null +++ b/docs/governance/council.md @@ -0,0 +1,12 @@ +--- +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. + +Key deliverables for the OGC include: + +* Drive prioritization and alignment across the DAO departments and working groups +* Chart a path to further decentralized DAO governance and operations diff --git a/docs/literature-content/grant-process.md b/docs/governance/grant-process.md similarity index 88% rename from docs/literature-content/grant-process.md rename to docs/governance/grant-process.md index 7043df0..3dc21c9 100644 --- a/docs/literature-content/grant-process.md +++ b/docs/governance/grant-process.md @@ -9,4 +9,4 @@ Olympus Grants aims to educate the community, increase Olympus infrastructure an The diagram below illustrates the decision-making process for approving grants. -![Grant Process](./grant-process.svg) +![Grant Process](/gitbook/assets/grant-process.svg) diff --git a/docs/governance/index.md b/docs/governance/index.md new file mode 100644 index 0000000..0755943 --- /dev/null +++ b/docs/governance/index.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +--- + +# Governance & DAO + +OlympusDAO is a network of dedicated community members who execute on decisions & protocol mechanisms voted on through community governance. + +The DAO is pursuing a strategy of “progressive decentralization.” Currently, major components of the protocol are controlled at a high-level by the DAO. Though, ultimately the focus is on creating a foundation at the Treasury, Policy and economic levels, and to enable the community to directly operate protocol mechanics – in a trust- and process-minimized fashion. diff --git a/docs/literature-content/policy-process.md b/docs/governance/policy-process.md similarity index 87% rename from docs/literature-content/policy-process.md rename to docs/governance/policy-process.md index d408a2c..79c1760 100644 --- a/docs/literature-content/policy-process.md +++ b/docs/governance/policy-process.md @@ -9,4 +9,4 @@ OlympusDAO’s Policy team monitors the protocol through key metrics related to The diagram below illustrates the decision-making process for amending/creating policies. -![Policy Process](./policy-process.svg) +![Policy Process](/gitbook/assets/policy-process.svg) diff --git a/docs/governance/policy.md b/docs/governance/policy.md new file mode 100644 index 0000000..72428f8 --- /dev/null +++ b/docs/governance/policy.md @@ -0,0 +1,9 @@ +--- +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). + +Policy closely monitors the behavior of the protocol and utilizes the powers assigned to them in the policy framework to actively manage the protocol. Policy is committed to help bring inflows into the treasury, and continue to increase OHM's relative backing, and help Olympus to continue developing products and services that grow the Olympus economy. diff --git a/docs/literature-content/treasury-process.md b/docs/governance/treasury-process.md similarity index 88% rename from docs/literature-content/treasury-process.md rename to docs/governance/treasury-process.md index 3a36c57..88df4fe 100644 --- a/docs/literature-content/treasury-process.md +++ b/docs/governance/treasury-process.md @@ -11,4 +11,4 @@ Every decision must go through a rigorous process prior to execution which inclu The diagram below illustrates the decision-making process for allocating funds from the treasury. -![Treasury Process](./treasury-process.svg) +![Treasury Process](/gitbook/assets/treasury-process.svg) diff --git a/docs/treasury/pol.md b/docs/treasury/pol.md new file mode 100644 index 0000000..767285b --- /dev/null +++ b/docs/treasury/pol.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +--- + +# Protocol Owned Liquidity + +Olympus pioneered the concept of protocol owned liquidity, and the Olympus protocol has always owned a substantial amount of the OHM liquidity. This ensures users and protocols are always able to swap OHM, regardless of market conditions and external events. + +The Olympus treasury keeps OHM liquidity on decentralized exchanges. With Range Bound Stability the balance between reserves and liquidity is algorithmic, with the goal to optimize the liquidity depth and reserves for robustness and long term market stability. diff --git a/docs/treasury/range-bound.md b/docs/treasury/range-bound.md new file mode 100644 index 0000000..540f975 --- /dev/null +++ b/docs/treasury/range-bound.md @@ -0,0 +1,133 @@ +--- +sidebar_position: 2 +sidebar_label: Range Bound Stability +--- + +# Range Bound Stability + +This document codifies the requirements for a system to implement the Range-Bound Stability model defined in the [recent paper](https://docs.google.com/document/u/2/d/e/2PACX-1vSIufbgAxAAtZkITd_s57o5AmyhAnk6iYbLYvN-ATL59hQ5nC2t2BTPvA8X9DYzFa-i3PRw9ARrAS9E/pub) by Zeus et al. + +--- + +## Components + +System is comprised of three components: + +1. the range setter + - price data (from oracle) + - moving average period length (from governance) + - spread (from governance) + - treasury data (from oracle) + - depth (from governance, % reserves) + - regeneration rate (from governance) +2. the treasury balancer + - asset data (from oracle) + - liquidity/reserve balance (from governance) + - offering length/reoffering period length (governance) + - vesting speed (closest liquid expiration?) + - bond depo integration +3. the liquidity maintainer + - pool list (need to verify) + +--- + +the range setter keeps track of a moving average of price +spanning Tma days. it applies a spread Sw to that moving average +to determine a range (MA _ 1-Sw, MA _ 1+Sw). it calculates the +amount to buy B at the range low using treasury T and the depth +factor Fb, and the amount to sell at the range high by scaling +the bid up by 2x radius and dividing by price at top of the +range (B _ (1+ (2 _ Sw)) / (MA \* 1+Sw)). it accepts trades at +range (low, high) up to depth (low, high). depth is regenerated +if price sits on the opposite side of the MA for Tt epochs in a +Tr period (ie 18 out of 21 epochs). + +--- + +the treasury balancer maintains a balance of liquidity and +reserve assets. when assets in liquidity change (as a result +of trading activity) or assets in reserves change (as a result +of range activity), this ratio is skewed. the balancer creates +bond markets to correct this skew (ie underweight reserves, +create bond market selling ohm for dai. overweight reserves, +create bond market selling dai for ohm). + +--- + +the liquidity maintainer maintains liquidity by minting +into xyk liquidity pools. it keeps a list of verified +pools to which it mints tokens at the staking reward rate +and calls the sync() function to update the pools virtual +balances. + +--- + +![range-denoted](/gitbook/assets/range-denoted.png) + +## Requirements + +### Protocol-enforced Range + +1. Calculate and maintain a moving average price for OHM against a specified reserve asset for a configurable duration. The MA price should be updated each system epoch. +2. Calculate lower and upper bounds for the price OHM against a specified reserve asset, both “wall” and “cushion” components, from the moving average price and configurable spread variables. + + +3. Allow users to swap OHM for reserves at the lower wall price (WL) and reserves for OHM at the upper wall price (WH) up to the specified capacity of the current walls. + + a. Capacity of the lower wall (bid) in reserves should be the amount of reserves in the Olympus Treasury multiplied by a configured bid factor (percent of reserves to use for each wall). + + b. Capacity of the upper wall (ask) in OHM should be the capacity of the lower wall (bid) divided by the upper wall price and scaled up by the difference in spread from the lower wall to the upper wall. + + c. When the capacity of either wall is depleted, the system should not allow additional swaps on that side until it is regenerated. + + d. When the capacity of the upper wall (ask) is depleted, the system should not reinstate a new wall with additional capacity until the current price is observed to be below the MA price for a X out of the last Y system epochs, where X and Y are configured parameters representing the regeneration threshold (X) and total number of observations (Y). Additionally, the wall should not regenerate until a minimum configured amount of time has past. + +4. Deploy a bond market to sell OHM for reserves when the current price of OHM against the reserve asset is greater than or equal to the upper cushion price at the system epoch with a capacity equal to the configured percentage of the upper wall capacity to use for the cushion. + + a. If a bond market is active on a system epoch, the system should close the market if the current price of OHM against the reserve is back below the upper cushion price or has exceeded the upper wall price. + + b. The bond market should be closed if the upper wall capacity is depleted. + + c. The bond market should be instant-swap with no vesting. + + d. The bond market should start at the upper wall price and have a minimum price of the upper cushion price. + +5. Deploy a bond market to buy OHM with reserves when the current price of OHM against the reserve asset is less than or equal to the lower cushion price at the system epoch with a capacity equal to the configured percentage of the lower wall capacity to use for the cushion. + + a. If a bond market is active on a system epoch, the system should close the market if the current price of OHM against the reserve is back above the lower cushion price or has gone below the lower wall price. + + b. The bond market should be closed if the lower wall capacity is depleted. + + c. The bond market should be instant-swap with no vesting. + + d. The bond market should start at the lower wall price and have a minimum price of the lower cushion price. + +### Treasury Rebalancing + +1. Maintain a configured target percent of the treasury’s reserve assets in the specified OHM-reserve liquidity pool for the reserve. + + a. The system should maintain this balance through the use of time-weighted automated market maker (TWAMM) orders that are executed over a configured amount of time and interval. + + b. The system should check the current percentage of treasury-owned reserves in the liquidity pool each system epoch and input TWAMM orders to correct imbalances that exceed a configured threshold. If an order is active on a system epoch, it should determine whether to close or continue the order before issuing a new one. + +### User-provided Range (Wall of Ohmies) + +1. Allows users to stake OHM, the reserve asset, or both to provide funds for a second wall at the cushion prices. + + a. The stake should be locked on deposit. + + b. Users should be able to unlock their stake which starts a configurable cooldown period. Once the cooldown period expires, they can withdraw their stake. + +2. Maintain a target ratio of value between the two assets in the pool to provide sufficient capital for both walls to support the range. + + a. The system should incentivize users to balance the ratio to the target by incentivizing them to provide the mix of tokens that moves the system closest to the target ratio. + + b. The target ratio should adjust based on the movement of price inside the range to avoid staker dilution from new staker incentives on price movements within the range. + +3. Allow users to withdraw their stake and receive a system defined mix of OHM and the reserve asset according to what will best help it correct to the target ratio. The system defined mix of assets prevents manipulation of incentives and circular incentive calculations on withdrawals. + +4. Pay a protocol defined token as a reward for staking. + + a. Allow the protocol to configure the rewards issued per day. + + b. Only users with locked stakes should receive diff --git a/docusaurus.config.js b/docusaurus.config.js index e95dcf5..7a48a34 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -75,36 +75,36 @@ const config = { srcDark: "img/logo_dark.svg", }, items: [ - { - type: "doc", - docId: "utility/index", - position: "left", - label: "Utility", - }, - { - type: "doc", - docId: "mechanics/stability/index", - position: "left", - label: "Stability", - }, - { - type: "doc", - docId: "mechanics/liquidity/index", - position: "left", - label: "Liquidity", - }, - { - type: "doc", - docId: "mechanics/governance/index", - position: "left", - label: "Governance", - }, - { - type: "doc", - docId: "technical-guides/index", - position: "left", - label: "Technical Docs", - }, + // { + // type: "doc", + // docId: "utility/index", + // position: "left", + // label: "Utility", + // }, + // { + // type: "doc", + // docId: "mechanics/stability/index", + // position: "left", + // label: "Stability", + // }, + // { + // type: "doc", + // docId: "mechanics/liquidity/index", + // position: "left", + // label: "Liquidity", + // }, + // { + // type: "doc", + // docId: "mechanics/governance/index", + // position: "left", + // label: "Governance", + // }, + // { + // type: "doc", + // docId: "technical-guides/index", + // position: "left", + // label: "Technical Docs", + // }, { href: "https://github.com/OlympusDAO/olympus-docs", label: "GitHub", diff --git a/sidebars.js b/sidebars.js index d9c09c6..1a8752d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -20,72 +20,54 @@ const sidebars = { // config options: https://docusaurus.io/docs/next/sidebar/items main: [ { - type: "doc", - id: "basics/readme", + type: "category", + label: "Basics", + collapsible: true, + collapsed: true, + link: { + type: "doc", + id: "basics/readme", + }, + items: [ + "basics/bonding", + "basics/inverse-bonds", + "basics/staking", + "basics/bophades" + ], }, { type: "category", - label: "Mechanics", + label: "Treasury", collapsible: true, collapsed: true, items: [ - { - type: "category", - label: "Stability", - collapsible: true, - collapsed: false, - link: { - type: "doc", - id: "mechanics/stability/index", - }, - items: [ - "mechanics/stability/range-bound", - "mechanics/stability/ohm-bonds", - "mechanics/stability/staking", - ], - }, - { - type: "category", - label: "Liquidity", - collapsible: true, - collapsed: false, - link: { - type: "doc", - id: "mechanics/liquidity/index", - }, - items: [ - "mechanics/liquidity/pol", - "mechanics/liquidity/flex-loans", - "mechanics/liquidity/lending-amos", - ], - }, - { - type: "category", - label: "Governance", - collapsible: true, - collapsed: false, - link: { - type: "doc", - id: "mechanics/governance/index", - }, - items: [], - }, + "treasury/pol", + "treasury/range-bound", ], }, { type: "category", - label: "Utility (How to Use Ohm)", + label: "Governance", collapsible: true, collapsed: true, link: { type: "doc", - id: "utility/index", + id: "governance/index", }, items: [ - "utility/staking", - "utility/providing-liquidity", - "utility/lending-collateral", - "utility/governance", + "governance/council", + "governance/policy", + { + type: "category", + label: "DAO Processes", + collapsible: true, + collapsed: true, + items: [ + "governance/treasury-process", + "governance/policy-process", + "governance/grant-process", + ] + } ], }, { @@ -127,62 +109,62 @@ const sidebars = { } ], }, - { - type: "category", - label: "Get Involved", - collapsible: true, - collapsed: true, - items: [ - { type: "autogenerated", dirName: "get-involved" }, - { - type: "link", - label: "Community Discord", - href: "https://discord-invite.olympusdao.finance", - }, - { - type: "link", - label: "Forum", - href: "https://forum.olympusdao.finance/", - }, - { - type: "link", - label: "Twitter", - href: "https://twitter.com/OlympusDAO", - }, - { - type: "link", - label: "Medium", - href: "https://olympusdao.medium.com/", - }, - { - type: "link", - label: "Snapshot", - href: "https://snapshot.org/#/olympusdao.eth", - }, - ], - }, - { - type: "category", - label: "Old Stuff", - collapsible: true, - collapsed: true, - items: [ - { - type: "category", - label: "Protocol Basics", - collapsible: true, - collapsed: true, - items: [{ type: "autogenerated", dirName: "basics" }], - }, - { - type: "category", - label: "Literature & Content", - collapsible: true, - collapsed: true, - items: [{ type: "autogenerated", dirName: "literature-content" }], - }, - ], - }, + // { + // type: "category", + // label: "Get Involved", + // collapsible: true, + // collapsed: true, + // items: [ + // { type: "autogenerated", dirName: "get-involved" }, + // { + // type: "link", + // label: "Community Discord", + // href: "https://discord-invite.olympusdao.finance", + // }, + // { + // type: "link", + // label: "Forum", + // href: "https://forum.olympusdao.finance/", + // }, + // { + // type: "link", + // label: "Twitter", + // href: "https://twitter.com/OlympusDAO", + // }, + // { + // type: "link", + // label: "Medium", + // href: "https://olympusdao.medium.com/", + // }, + // { + // type: "link", + // label: "Snapshot", + // href: "https://snapshot.org/#/olympusdao.eth", + // }, + // ], + // }, + // { + // type: "category", + // label: "Old Stuff", + // collapsible: true, + // collapsed: true, + // items: [ + // { + // type: "category", + // label: "Protocol Basics", + // collapsible: true, + // collapsed: true, + // items: [{ type: "autogenerated", dirName: "basics" }], + // }, + // { + // type: "category", + // label: "Literature & Content", + // collapsible: true, + // collapsed: true, + // items: [{ type: "autogenerated", dirName: "literature-content" }], + // }, + // ], + // }, ], }; diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 2301c18..0803f86 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -16,29 +16,30 @@ import { BookOpenIcon, ChatBubbleLeftIcon, CodeBracketIcon, + BuildingLibraryIcon } from "@heroicons/react/24/outline"; export const actions = [ { - title: "What is Olympus", + title: "Basics", href: "#", icon: InformationCircleIcon, to: "./main/basics/readme", - text: `Learn about the core concepts of the Olympus Protocol`, + text: `Olympus Protocol core concepts`, }, { - title: "Utility", + title: "Treasury", href: "#", - icon: BookOpenIcon, - to: "./main/utility/", - text: `Needs copy`, + icon: BuildingLibraryIcon, + to: "./main/treasury/pol", + text: `All about Olympus Treasury`, }, { - title: "Technical Guides", + title: "Governance", href: "#", - icon: QuestionMarkCircleIcon, - to: "./main/technical-guides", - text: `Learn about interacting with the website or directly with the contracts`, + icon: BookOpenIcon, + to: "./main/governance", + text: `An overview of Olympus Governance`, }, ]; @@ -73,7 +74,7 @@ export const Guides = [ { title: "Treasury", text: "The Treasury represents all assets owned and controlled by the protocol", - to: "./main/basics/treasury", + to: "./main/treasury/pol", }, { title: "Inverse Bonds", diff --git a/docs/literature-content/grant-process.mmd b/static/gitbook/assets/grant-process.mmd similarity index 100% rename from docs/literature-content/grant-process.mmd rename to static/gitbook/assets/grant-process.mmd diff --git a/docs/literature-content/grant-process.svg b/static/gitbook/assets/grant-process.svg similarity index 100% rename from docs/literature-content/grant-process.svg rename to static/gitbook/assets/grant-process.svg diff --git a/docs/literature-content/policy-process.mmd b/static/gitbook/assets/policy-process.mmd similarity index 100% rename from docs/literature-content/policy-process.mmd rename to static/gitbook/assets/policy-process.mmd diff --git a/docs/literature-content/policy-process.svg b/static/gitbook/assets/policy-process.svg similarity index 100% rename from docs/literature-content/policy-process.svg rename to static/gitbook/assets/policy-process.svg diff --git a/docs/literature-content/treasury-process.mmd b/static/gitbook/assets/treasury-process.mmd similarity index 100% rename from docs/literature-content/treasury-process.mmd rename to static/gitbook/assets/treasury-process.mmd diff --git a/docs/literature-content/treasury-process.svg b/static/gitbook/assets/treasury-process.svg similarity index 100% rename from docs/literature-content/treasury-process.svg rename to static/gitbook/assets/treasury-process.svg