Issue #112: Fix docs issues, add instructions for editing/publishing (#…

…113) * docs fixes * docs fixes * one slash
open-dollar · Jul 3, 2024 · 78c550c · 78c550c
1 parent 443d493
commit 78c550c
Show file tree

Hide file tree

Showing 21 changed files with 26 additions and 20 deletions.
diff --git a/docs/Audits.mdx b/docs/Audits.mdx
@@ -2,16 +2,14 @@
 title: Audits
 ---
 
-Last updated: 05/07/24\
+Last updated: 07/01/24\
 \
 The core GEB contracts were audited by [OpenZeppelin](https://github.com/reflexer-labs/geb-audits/tree/master/open-zeppelin/core-contracts).\
 \
 The Open Dollar protocol has also been audited by:\
 \
-[Code4rena\
-](https://code4rena.com/contests/2023-10-open-dollar)\
-[Quantstamp](https://certificate.quantstamp.com/full/open-dollar-smart-contract-audit/202828fa-eb09-4d33-beab-c1ebee11ebd1/index.html)
+[<img src="./img/code4rena.png" alt="code4rena" />](https://code4rena.com/contests/2023-10-open-dollar)\
+[<img src="./img/quantstamp.png" alt="quantstamp" />](https://certificate.quantstamp.com/full/open-dollar-smart-contract-audit/202828fa-eb09-4d33-beab-c1ebee11ebd1/index.html)
 
-[Pashov Audit Group\
-](https://www.pashov.net/)\
-In addition to a semi-automated security scan followed by manual verification by [Pessimistic](https://pessimistic.io/)
+[<img src="./img/pashov-audit-group.png" alt="pashov-audit-group" />](https://www.pashov.net/)\
+In addition to a semi-automated security scan followed by manual verification by [<img src="./img/pessimistic.png" alt="pessimistic" />](https://pessimistic.io/)
diff --git a/docs/How-OD-Stays-Stable.mdx b/docs/How-OD-Stays-Stable.mdx
@@ -15,7 +15,7 @@ Since OD is now cheaper inside the protocol compared to the market, borrowing po
 
 Example: If the redemption price of OD decreases by 0.2%, users can leverage their collateral to borrow 0.2% more OD from Open Dollar. They then sell their OD at market price, earning a profit from the price deviation, and protecting themselves from a drop in the token’s value following the negative redemption rate.
 
-<img src="./img/How OD stays stable Image 3.png" alt="How OD stays stable Image 3" />
+<img src="./img/How OD stays Stable Image 3.png" alt="How OD stays stable Image 3" />
 
 <img src="./img/How OD stays Stable Image 4.png" alt="How OD stays Stable Image 4" />
 

diff --git a/docs/Leverage.mdx b/docs/Leverage.mdx
@@ -51,7 +51,7 @@ In the second step of leverage, the same process is repeated: The user borrows t
 * Liquidation Threshold: $1,967.21 per wstETH
 * Net APY: 6.61% ($2,644)
 
-With the position now leveraged to a multiple of 2.44x, the net APY of 6.61%(\\$2,644) is an increase of 73.95% of the original of 3.8%($1,520), inclusive of borrowing fees. Note that the liquidation threshold has also risen and the collateralization ratio has dropped relative to the previous step.
+With the position now leveraged to a multiple of 2.44x, the net APY of 6.61%(\$2,644) is an increase of 73.95% of the original of 3.8%($1,520), inclusive of borrowing fees. Note that the liquidation threshold has also risen and the collateralization ratio has dropped relative to the previous step.
 
 
 ## The Trend
@@ -101,7 +101,7 @@ In the third step of leverage, the same process is repeated:
 * Liquidation Threshold: $2,341.74 per wstETH
 * Net APY: 8.41% ($3,364)
 
-In the final step, the user reaches their target collateralization ratio with a leveraged position of 3.36x more wstETH collateral than their original amount of 10 wstETH. They now have nearly $118,080 in wstETH and a 121.32% greater net yield of 8.41% ($3,364) versus their original yield of only 3.8% (\\$1,520), inclusive of the 1.85% APR borrowing fees.
+In the final step, the user reaches their target collateralization ratio with a leveraged position of 3.36x more wstETH collateral than their original amount of 10 wstETH. They now have nearly $118,080 in wstETH and a 121.32% greater net yield of 8.41% ($3,364) versus their original yield of only 3.8% (\$1,520), inclusive of the 1.85% APR borrowing fees.
 
 
 The liquidation threshold is now at $2,341.74, or roughly 41.5% less than the market price of wstETH when they began. Depending on the risk tolerance and yield goals of the user, they could continue, but in this scenario, they have reached their target and are comfortable with these values.

diff --git a/docs/Liquidations.mdx b/docs/Liquidations.mdx
@@ -11,4 +11,4 @@ If the value of the collateral in a vault falls below the minimum collateral rat
 
 During liquidations, a vault's collateral is lost as it is used to pay off the account's debt. The vault owner will no longer be able to retrieve the collateral by repaying debt. The liquidation penalty varies by collateral type and can be referenced when opening the vault.\
 \
-There is a max liquidation limit set by the protocol of 100,000 OD, for liquidations of vaults with larger values there will be multiple rounds of liquidation.
+There is a max liquidation limit set by the protocol of 100,000 OD for liquidations of vaults with larger values there will be multiple rounds of liquidation.
diff --git a/docs/Mainnet-App-Guide.mdx b/docs/Mainnet-App-Guide.mdx
@@ -4,9 +4,8 @@ title: Mainnet App Guide
 
 # Mainnet App Guide
 
-\<iframe src="[https://player.vimeo.com/video/941409534?h=b6e51ff5fa](https://player.vimeo.com/video/941409534?h=b6e51ff5fa)" width="640" height="360" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen>\</iframe>
+<iframe src="https://player.vimeo.com/video/941409534?h=b6e51ff5fa" width="640" height="360" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe>
 
-\
 Connecting to the App
 ---------------------
 

diff --git a/docs/NFV-Information.mdx b/docs/NFV-Information.mdx
@@ -0,0 +1,6 @@
+---
+title: NFV Information
+description: ''
+---
+
+<img src="./img/Elevated Risk Vault.png" alt="Elevated Risk Vault" />
diff --git a/docs/Tokenomics.mdx b/docs/Tokenomics.mdx
@@ -10,6 +10,8 @@ title: Tokenomics
 
 <img src="./img/OD Protocol Fees.png" alt="OD Protocol Fees" />
 
+*assuming 2% APR and one year loan
+
 ### **Cap Table + Vesting Details**
 
 | Category                        | Initial Percent | Lockup                               |

diff --git a/docs/faq.mdx b/docs/faq.mdx
@@ -7,7 +7,7 @@ description: Frequently asked questions about Open Dollar
 
 ### What is Open Dollar?
 
-Open Dollar is the protocol that issues OD, a floating \\$1.00 pegged stablecoin backed by Liquid Staking Tokens and other deep liquidity tokens such as ARB with NFT-controlled vaults built on Arbitrum.
+Open Dollar is the protocol that issues OD, a floating \$1.00 pegged stablecoin backed by Liquid Staking Tokens and other deep liquidity tokens such as ARB with NFT-controlled vaults built on Arbitrum.
 
 ### How does OD stay stable?
 
@@ -143,11 +143,11 @@ To better understand how OD behaves, we need to analyze its monetary policy whic
 
 Let's walk through an example of how OD is revalued in case of capital inflow of some Liquid Staked Token that we can call lstETH (meaning people are bullish on lstETH ):
 
-* At time T1: lstETH price is \\$500, OD's market and redemption prices are both \\$1.
-* At time T2: lstETH price surges to \\$1000. Open Dollar vault users suddenly have more borrowing power and generate more OD against their collateral. Those users sell OD on the secondary market (like an exchange), causing OD's market price to drop to \\$0.95. Users might be selling to create leveraged long positions or to access capital without having to sell their lstETH.
-* At time T3: lstETH remains at \\$1000 and OD's market price is still \\$0.95. The protocol wants the market price to get close to the redemption price. In order to eliminate the imbalance between the market/redemption prices, the system starts to revalue OD. Revaluing consists in setting a positive redemption rate which makes the redemption price grow every second.
-* At time T4: lstETH remains at \\$1000. OD's redemption price is now \\$1.05. Vault users are starting to realize that they can now borrow less OD per one lstETH, they can redeem less lstETH during Settlement (because OD is now more expensive), and that it will be more expensive to close their vault once the market price follows the redemption price. At the same time, OD holders are starting to realize that they can redeem more and more ETH during settlement.
-* At time T5: lstETH remains at \\$1000. OD's redemption price is now \\$1.10. OD's market price surged to \\$1.01 as a result of vault users buying OD in order to close their positions as soon as possible instead of later on when OD is more expensive.
+* At time T1: lstETH price is \$500, OD's market and redemption prices are both \$1.
+* At time T2: lstETH price surges to \$1000. Open Dollar vault users suddenly have more borrowing power and generate more OD against their collateral. Those users sell OD on the secondary market (like an exchange), causing OD's market price to drop to \$0.95. Users might be selling to create leveraged long positions or to access capital without having to sell their lstETH.
+* At time T3: lstETH remains at \$1000 and OD's market price is still \$0.95. The protocol wants the market price to get close to the redemption price. In order to eliminate the imbalance between the market/redemption prices, the system starts to revalue OD. Revaluing consists in setting a positive redemption rate which makes the redemption price grow every second.
+* At time T4: lstETH remains at \$1000. OD's redemption price is now \$1.05. Vault users are starting to realize that they can now borrow less OD per one lstETH, they can redeem less lstETH during Settlement (because OD is now more expensive), and that it will be more expensive to close their vault once the market price follows the redemption price. At the same time, OD holders are starting to realize that they can redeem more and more ETH during settlement.
+* At time T5: lstETH remains at \$1000. OD's redemption price is now \$1.10. OD's market price surged to \$1.01 as a result of vault users buying OD in order to close their positions as soon as possible instead of later on when OD is more expensive.
 
 When OD is devalued (in the case of lstETH capital outflow), the opposite happens:
 

diff --git a/public/img/Elevated Risk Vault.png b/public/img/Elevated Risk Vault.png
diff --git a/public/img/OD Protocol Fees.png b/public/img/OD Protocol Fees.png
diff --git a/public/img/code4rena.png b/public/img/code4rena.png
diff --git a/public/img/pashov-audit-group.png b/public/img/pashov-audit-group.png
diff --git a/public/img/pessimistic.png b/public/img/pessimistic.png
diff --git a/public/img/quantstamp.png b/public/img/quantstamp.png
diff --git a/sidebars.js b/sidebars.js
@@ -69,6 +69,7 @@ const sidebars = {
       items: [
           "NFT-Vaults-Overview",
           "Leverage",
+          "NFV-Information"
       ],
     },
     {
@@ -125,7 +126,7 @@ const sidebars = {
       type: "category",
       label: "👨‍💻 Developer Resources",
       collapsible: true,
-      collapsed: false,
+      collapsed: true,
       items: [
           "developer-readme",
         {

diff --git a/static/img/Elevated Risk Vault.png b/static/img/Elevated Risk Vault.png
diff --git a/static/img/OD Protocol Fees.png b/static/img/OD Protocol Fees.png
diff --git a/static/img/code4rena.png b/static/img/code4rena.png
diff --git a/static/img/pashov-audit-group.png b/static/img/pashov-audit-group.png
diff --git a/static/img/pessimistic.png b/static/img/pessimistic.png
diff --git a/static/img/quantstamp.png b/static/img/quantstamp.png