feat: add links to edit files on github

alcueca · alcueca · commit 4402967970f6 · 2022-05-31T13:49:55.000+01:00
diff --git a/README.md b/README.md
@@ -69,3 +69,5 @@ You can check out our open roles here on our [careers](https://yieldprotocol.com
 ## Info on these Docs
 
 You can run this documentation offline by using [Docsify](https://docsify.js.org/#/). Fork this repo, [install Docsify](https://docsify.js.org/#/quickstart) on your local machine, and then in the root folder of this repo, type `docsify serve`. The website will be served on port 3000 on your localhost: `localhost:3000`.
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/README.md)
diff --git a/developers/README.md b/developers/README.md
@@ -16,4 +16,6 @@ To ensure that vaults are properly collateralized, Yield has various **Oracle**
 
 If users fail to maintain the appropriate level of collateral, they may be liquidated via **Witch**, Yield’s liquidation engine. Witch permits anyone to kick off the liquidation process for an undercollateralized vault. Liquidation is performed via an increasing price auction that increases the amount of collateral the system is willing to pay to cover the debt.
 
-Yield includes an internal AMM to provide liquidity for fyTokens. The AMM is called YieldSpace. YieldSpace is implemented in the **Pool** contract. A **PoolRouter** contract manages calls to and from the pool. YieldSpace pools are designed to trade in interest rates space. That means that the pool will quote trades at the same marginal interest rate over time, absent any trading activity (that would change the interest rate).
+Yield includes an internal AMM to provide liquidity for fyTokens. The AMM is called YieldSpace. YieldSpace is implemented in the **Pool** contract. A **PoolRouter** contract manages calls to and from the pool. YieldSpace pools are designed to trade in interest rates space. That means that the pool will quote trades at the same marginal interest rate over time, absent any trading activity (that would change the interest rate).
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/developers/README.md)
diff --git a/developers/addresses.md b/developers/addresses.md
@@ -3,5 +3,7 @@
 All contract addresses and identifiers can be obtained through the "Download" button on the lower right corner of the application.
 
 <figure class="image" align = "center">
-  <img src="../../assets/addresses.png" alt="download button" title="download addresses and identifiers">
-</figure>
+  <img src="../assets/addresses.png" alt="download button" title="download addresses and identifiers">
+</figure>
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/developers/addresses.md)
diff --git a/developers/addresses/readme.md b/developers/addresses/readme.md
diff --git a/developers/emergencies.md b/developers/emergencies.md
@@ -221,3 +221,5 @@ In a case of a Strategy malfunction, it can be removed from the Ladle. However,
 ```
 ladle.addToken(strategy, false)
 ladle.addIntegration(strategy, false)
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/developers/emergencies.md)
diff --git a/developers/governance.md b/developers/governance.md
@@ -41,3 +41,5 @@ In the EmergencyBrake, the **Timelock** has the permission to `plan` emergencies
 
 
 In the EmergencyBrake, the **operations team** has the permission to `execute` plans, effectively pausing parts of the protocol.
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/developers/governance.md)
diff --git a/developers/smart_contracts_overview.md b/developers/smart_contracts_overview.md
@@ -348,3 +348,5 @@ The Yield Protocol uses its own implementation of a Timelock, derived from Compo
 ## EmergencyBrake
 
 The EmergencyBrake stores the instructions to remove the orchestration between contracts, which is intended to be used in emergency situations to easily isolate parts of the protocol.
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/developers/smart_contracts_overview.md)
diff --git a/governance/governance.md b/governance/governance.md
@@ -14,4 +14,6 @@ All changes to the protocol are executed through the Timelock.
 
 1. The operations team will submit the proposal, which is a series of function calls to be executed from the Timelock, calling `propose` in the Timelock.
 2. The owners of the multisig, or the community in its case, can independently decode the proposal to verify its contents. If it is collectively decided to approve the proposal, the governor account will call `approve` on the Timelock for the proposal hash.
-3. The operations team will `execute` the approved proposal, no earlier than the delay set in the Timelock. The proposal will be executed from the Timelock.
+3. The operations team will `execute` the approved proposal, no earlier than the delay set in the Timelock. The proposal will be executed from the Timelock.
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/governance/governance.md)
diff --git a/governance/verify_proposal.md b/governance/verify_proposal.md
@@ -57,3 +57,5 @@ The Timelock is asking the ChainlinkMultiOracle to set a new source:
  - Data source: [0x986b5E1e1755e3C2440e960477f25201B0a8bbD4](https://etherscan.io/address/0x986b5E1e1755e3C2440e960477f25201B0a8bbD4)
 
 **Note:** Often, a proposal will be for grantRole, grantRoles, revokeRole, or revokeRoles. The role is a 4-byte parameter, such as `0xef532f2e`. We can enter this role in the [4byte database](https://www.4byte.directory/signatures/?bytes4_signature=0xef532f2e), and we will know which permission is being given (`setSources` in the example).
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/governance/verify_proposal.md)
diff --git a/operations/README.md b/operations/README.md
@@ -0,0 +1 @@
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/README.md)
diff --git a/operations/code_reviews.md b/operations/code_reviews.md
@@ -56,3 +56,5 @@ Opinionated **security**, **code quality** standards, and **code review policies
 - Notify reviewers if any changes are made to obtain final approval
 - **Must have at least 1 approval prior to merge**
 - Merge PR and close related Github issue
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/code_reviews.md)
diff --git a/operations/deployment.md b/operations/deployment.md
@@ -1021,3 +1021,6 @@ proposal.push(
 
 
 **Input**: governance.json, protocol.json, pools.json, strategies.json
+
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/deployment.md)
diff --git a/operations/emergency_plans.md b/operations/emergency_plans.md
@@ -20,4 +20,6 @@
 | ladle   | fyToken(0204) | 0x7c7e994828f8adf83ec70ed8af4b269e1da635f3d75a82d75176b6341a297ac9 |
 | fyToken | join(02)      | 0xb22960b37717835a0fed7c666e6af2f956d5d4e39c1e4a08cbc6986105626d9c |
 | ladle   | fyToken(0205) | 0x242423d1d59bce31941ca5ea020902913a7bae637424bf299e822aacbeaab235 |
-| fyToken | join(02)      | 0xd37ff9e3d065d11a938459ffdb030651177d546da21f0949cb16ccc7bb4c6908 |
+| fyToken | join(02)      | 0xd37ff9e3d065d11a938459ffdb030651177d546da21f0949cb16ccc7bb4c6908 |
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/emergency_plans.md)
diff --git a/operations/emergency_procedure.md b/operations/emergency_procedure.md
@@ -184,3 +184,5 @@ Participants are encouraged to provide inputs on each of the steps. If a partici
    - Changes in the process and documentation
    - Changes in code and tests to validate
    - Changes in tools implemented and incorporated into the process
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/emergency_procedure.md)
diff --git a/operations/readme.md b/operations/readme.md
diff --git a/operations/support_procedure.md b/operations/support_procedure.md
@@ -18,5 +18,4 @@ The goal is to maximise the user satisfaction with the use of the Yield Protocol
 12. Regular updates on progress will be given to the user no more than 24h apart, with an expectation for the time of the next update.
 13. Upon resolution, the user will be informed of the status, and the knowledge base of know issues will be updated with the resolution or workaround.
 
-
-
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/support_procedure.md)
diff --git a/troubleshooting.md b/troubleshooting.md
@@ -58,3 +58,6 @@ If you have been liquidated, we need to verify that you own the liquidated vault
  - Tell us your address.
  - If there is any debugging information (a long string of non-sensical hexadecimal data), please copy and paste that in the ticket.
  - Please be aware that certain levels of support are only available during European or American business hours.
+
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/troubleshooting.md)
diff --git a/users/borrowing.md b/users/borrowing.md
@@ -57,3 +57,5 @@ If a borrower fails to do so, they may be liquidated: their collateral will be s
 <!-- For ETH collateral, fyDAI uses the same collateralization ratio as MakerDAO, which is currently 150%. -->
 
 <!-- TODO: Need to expand upon what ratio will be used for different collateral and different assets -->
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/users/borrowing.md)
diff --git a/users/gas_costs.md b/users/gas_costs.md
@@ -10,3 +10,5 @@ Yield v2 has been built aiming to achieve a minimal gas cost. For reference, the
 |                             |      |            |         |
 
 Please be aware that the Yield v2 transactions are built dynamically for each request, and gas costs might vary by a small amount for each specific situation.
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/users/gas_costs.md)
diff --git a/users/lending.md b/users/lending.md
@@ -25,4 +25,6 @@ To compensate lenders who do not redeem fyTokens right away, after maturity they
 
 If you own fyDai after maturity, you will start to earn the Dai Savings Rate on your fyDai, until you decide to redeem it for Dai.
 
- ![](../assets/redemption.png)
+ ![](../assets/redemption.png)
+
+ [Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/users/lending.md)
diff --git a/users/liquidity.md b/users/liquidity.md
@@ -29,4 +29,6 @@ The Yield Pool formula reduces the market impact suffered by traders of fyToken,
 The x-axis is the amount of fyDai sold. The y-axis is the implicit interest rate achieved by a borrower who is selling that amount of fyDai at one year to maturity. Borrowers obtain considerably better fyDai/Dai quotes (with better implied interest rates) by using the Yield Pool.
 
 ![](../assets/market_impact.png)<br>
-YieldSpace consistently outperforms Uniswap on both interest rates and market quotes</figcaption>
+YieldSpace consistently outperforms Uniswap on both interest rates and market quotes</figcaption>
+
+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/users/liquidity.md)

Original file line number	Diff line number	Diff line change
@@ -41,3 +41,5 @@ In the EmergencyBrake, the Timelock has the permission to `plan` emergencies
`41`	`41`
`42`	`42`
`43`	`43`	In the EmergencyBrake, the operations team has the permission to `execute` plans, effectively pausing parts of the protocol.
	`44`	`+`
	`45`	`+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/developers/governance.md)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[Edit this page](https://github.com/yieldprotocol/docs-v2/edit/main/operations/README.md)`