doc: improve style of documentation

astrodevs-labs · Sep 5, 2023 · 01ddafc · 01ddafc
1 parent 4b4012a
commit 01ddafc
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 15 deletions.
diff --git a/docs/retype.yml b/docs/retype.yml
@@ -3,7 +3,8 @@ output: .retype
 url: https://doc.tholgar.xyz
 branding:
   title: Tholgar
-  label: Docs
+  label: ""
   logo: assets/logo512.png
+  favicon: static/favicon.ico
 footer:
   copyright: "&copy; Copyright {{ year }}. All rights reserved."
diff --git a/docs/static/favicon.ico b/docs/static/favicon.ico
diff --git a/docs/warlord-vault/deposit.md b/docs/warlord-vault/deposit.md
@@ -12,7 +12,7 @@ Currently, two set of tokens can be deposited : WAR and AURA/CVX. The process is
 
 The war deposit is the default option when the app is loaded. You can still retrieve it by selecting the deposit tab and selecting WAR token in the bottom-left dropdown.
 
-![WAR Deposit](../assets/WarDeposit.png)
+![](../assets/WarDeposit.png)
 
 ### Depositing
 
@@ -25,27 +25,27 @@ Enter the desired amount of WAR you wish to deposit and click the "Deposit" butt
 A dialog will open by first asking you to approve the WAR spending (according to ERC-20 standards).
 You can select to approve only your deposit amount or approve the max spending to avoid this step on the following deposits.
 
-![Approve allowances](../assets/WarDeposit-Approve.png)
+![](../assets/WarDeposit-Approve.png)
 
 #### Deposit
 
 You will then be prompted to sign the transaction to deposit. This is the final step.
 
-![Deposit](../assets/WarDeposit-Deposit.png)
+![](../assets/WarDeposit-Deposit.png)
 
 #### Verify
 
 The "Circulating Supply" and "War Locked" stats should be increased by your deposit amount. If it is not immediatly the case, try to refresh you page.
 
-![Deposited](../assets/WarDeposit-Deposited.png)
+![](../assets/WarDeposit-Deposited.png)
 
 
 ## Deposit AURA/CVX
 ### Accessing AURA/CVX deposit
 
 To access AURA/CVX deposit, you need to change the deposit token(s) by using the bottom-left dropdown in the deposit tab.
 
-![Aura/CVX deposit](../assets/AuraCvxDeposit.png)
+![](../assets/AuraCvxDeposit.png)
 
 ### Depositing
 
@@ -58,17 +58,17 @@ Enter the desired amount of AURA and/or CVX you wish to deposit and click the "D
 A dialog will open by first asking you to approve the AURA and CVX spendings (according to ERC-20 standards).
 You can select to approve only your deposit amount or approve the max spending to avoid those step on the following deposits.
 
-![Approve AURA allowances](../assets/AuraCvxDeposit-ApproveAura.png)
-![Approve CVX allowances](../assets/AuraCvxDeposit-ApproveCvx.png)
+![](../assets/AuraCvxDeposit-ApproveAura.png)
+![](../assets/AuraCvxDeposit-ApproveCvx.png)
 
 #### Deposit
 
 You will then be prompted to sign the transaction to deposit. This is the final step.
 
-![Deposit](../assets/AuraCvxDeposit-Deposit.png)
+![](../assets/AuraCvxDeposit-Deposit.png)
 
 #### Verify
 
 The "Circulating Supply" and "War Locked" stats should be increased by your deposit amounts wheighted by the current ratios. If it is not immediatly the case, try to refresh you page.
 
-![Deposited](../assets/AuraCvxDeposit-Deposited.png)
+![](../assets/AuraCvxDeposit-Deposited.png)
diff --git a/docs/warlord-vault/smart_contracts/index.md b/docs/warlord-vault/smart_contracts/index.md
@@ -0,0 +1 @@
+Technical documentation for all Warlord Vault smart contracts.
diff --git a/docs/warlord-vault/twar.md b/docs/warlord-vault/twar.md
@@ -35,7 +35,7 @@ All of the code of the server that will make the calls is open source and can be
 The only fee taken by the vault is **5%** of the yield harvested only in WETH (excluding WAR directly harvested). This fee is used to cover gas fees and will decline as the Vault grows.
 
 ## Security
-
-We follow the industry standard for smart contract development and use the solmate library to implement our contracts.  
 
 All of the funds held by the Vault are non custodial meaning that admins will never be able to access them.  
+
+At the current stage, the vaylt has not undergone a formal security audit. However, the contracts have undergone extensive internal testing & external reviews, giving confidence in the existing security measures implemented. We strongly advise users to conduct their own research and make informed decisions based on their individual risk tolerance.
diff --git a/docs/warlord-vault/withdraw.md b/docs/warlord-vault/withdraw.md
@@ -10,7 +10,7 @@ You can currently withdraw your tWAR into WAR tokens.
 
 You can access the WAR withdraw by selecting the withdraw tab.
 
-![WAR Withdraw](../assets/WarWithdraw.png)
+![](../assets/WarWithdraw.png)
 
 ### Withdrawing
 
@@ -22,10 +22,10 @@ Enter the desired amount of tWAR you wish to withdraw and click the "Withdraw" b
 
 A dialog will open by first asking you to sign the withdraw transaction.
 
-![Approve allowances](../assets/WarWithdraw-Withdraw.png)
+![](../assets/WarWithdraw-Withdraw.png)
 
 #### Verify
 
 The "Circulating Supply" and "War Locked" stats should be decreased by your withdraw amount. If it is not immediatly the case, try to refresh you page.
 
-![Deposited](../assets/WarWithdraw-Withdrawn.png)
+![](../assets/WarWithdraw-Withdrawn.png)