diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b2bb36 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Welcome + diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..884e2fb --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,71 @@ +# Table of contents + +* [Welcome](README.md) + +## Getting Started + +* [Understanding Fixed Forex](getting-started/understanding-fixed-forex.md) +* [Fixed Forex Use Cases](getting-started/fixed-forex-use-cases.md) +* [Glossary](getting-started/glossary.md) + +## $KP3R Token + +* [Understanding $KP3R](usdkp3r-token/understanding-usdkp3r.md) +* [$KP3R FAQ](usdkp3r-token/usdkp3r-faq.md) +* [$KP3R Tokenomics](usdkp3r-token/usdkp3r-tokenomics.md) + +## Minting + +* [How to Mint ib Stables](minting/how-to-mint-ib-stables.md) + +## Swap Assets + +* [Fixed Forex's ibAMM](swap-assets/fixed-forexs-ibamm.md) +* [Using Curve](swap-assets/using-curve.md) +* [Using Synthetix](swap-assets/using-synthetix.md) + +## Providing Liquidity + +* [Why Provide Liquidity?](providing-liquidity/why-provide-liquidity.md) +* [Liquidity Providing Options](providing-liquidity/liquidity-providing-options.md) + +## Options Liquidity Mining + +* [OLM Explained](options-liquidity-mining/olm-explained.md) +* [Claiming OLM Rewards](options-liquidity-mining/claiming-olm-rewards.md) + +## Fixed Forex Reward Gauges + +* [Gauge Voting Explained](fixed-forex-reward-gauges/gauge-voting-explained.md) +* [How to Vote](fixed-forex-reward-gauges/how-to-vote.md) + +## Vesting + +* [Benefits of Vesting](vesting/benefits-of-vesting.md) +* [How Vesting Works](vesting/how-vesting-works.md) +* [How to Vest](vesting/how-to-vest.md) + +## Governance + +* [Governance Responsibilities](governance/governance-responsibilities.md) +* [Multisig](governance/multisig.md) + +## Developers + +* [Contract Addresses](developers/contract-addresses.md) + +## Appendix + +* [Audits](appendix/audits.md) +* [Security](appendix/security.md) + +## Links + +* [FixedForex.fi](https://fixedforex.fi/) +* [Telegram](https://t.me/keep3r\_official) +* [Discord](https://discord.gg/wxS8HTMW) +* [Medium](https://medium.com/keep3r-network) +* [Fixed Forex Forum](https://gov.yearn.finance/c/projects/fixed-forex/26) +* [Keep3r Forum](https://gov.yearn.finance/c/projects/keep3r/20) +* [GitHub](https://github.com/keep3r-network/ff) +* [Dune Analytics Fixed Forex](https://dune.com/ChainsightAnalytics/Fixed-Forex) diff --git a/appendix/audits.md b/appendix/audits.md new file mode 100644 index 0000000..472610c --- /dev/null +++ b/appendix/audits.md @@ -0,0 +1,2 @@ +# Audits + diff --git a/appendix/security.md b/appendix/security.md new file mode 100644 index 0000000..3ebfc6f --- /dev/null +++ b/appendix/security.md @@ -0,0 +1,2 @@ +# Security + diff --git a/developers/contract-addresses.md b/developers/contract-addresses.md new file mode 100644 index 0000000..a7511bf --- /dev/null +++ b/developers/contract-addresses.md @@ -0,0 +1,7 @@ +# Contract Addresses + +| Name | Description | Address | +| ---- | ----------- | ------- | +| | | | +| | | | +| | | | diff --git a/fixed-forex-reward-gauges/gauge-voting-explained.md b/fixed-forex-reward-gauges/gauge-voting-explained.md new file mode 100644 index 0000000..df48e8a --- /dev/null +++ b/fixed-forex-reward-gauges/gauge-voting-explained.md @@ -0,0 +1,2 @@ +# Gauge Voting Explained + diff --git a/fixed-forex-reward-gauges/how-to-vote.md b/fixed-forex-reward-gauges/how-to-vote.md new file mode 100644 index 0000000..c948d26 --- /dev/null +++ b/fixed-forex-reward-gauges/how-to-vote.md @@ -0,0 +1,2 @@ +# How to Vote + diff --git a/getting-started/fixed-forex-use-cases.md b/getting-started/fixed-forex-use-cases.md new file mode 100644 index 0000000..7f03578 --- /dev/null +++ b/getting-started/fixed-forex-use-cases.md @@ -0,0 +1,2 @@ +# Fixed Forex Use Cases + diff --git a/getting-started/glossary.md b/getting-started/glossary.md new file mode 100644 index 0000000..e71c336 --- /dev/null +++ b/getting-started/glossary.md @@ -0,0 +1,2 @@ +# Glossary + diff --git a/getting-started/understanding-fixed-forex.md b/getting-started/understanding-fixed-forex.md new file mode 100644 index 0000000..7e1b8e7 --- /dev/null +++ b/getting-started/understanding-fixed-forex.md @@ -0,0 +1,2 @@ +# Understanding Fixed Forex + diff --git a/governance/governance-responsibilities.md b/governance/governance-responsibilities.md new file mode 100644 index 0000000..fa64ca9 --- /dev/null +++ b/governance/governance-responsibilities.md @@ -0,0 +1,2 @@ +# Governance Responsibilities + diff --git a/governance/multisig.md b/governance/multisig.md new file mode 100644 index 0000000..3ba92b4 --- /dev/null +++ b/governance/multisig.md @@ -0,0 +1,2 @@ +# Multisig + diff --git a/minting/how-to-mint-ib-stables.md b/minting/how-to-mint-ib-stables.md new file mode 100644 index 0000000..5b563d4 --- /dev/null +++ b/minting/how-to-mint-ib-stables.md @@ -0,0 +1,2 @@ +# How to Mint ib Stables + diff --git a/options-liquidity-mining/claiming-olm-rewards.md b/options-liquidity-mining/claiming-olm-rewards.md new file mode 100644 index 0000000..aa5432f --- /dev/null +++ b/options-liquidity-mining/claiming-olm-rewards.md @@ -0,0 +1,2 @@ +# Claiming OLM Rewards + diff --git a/options-liquidity-mining/olm-explained.md b/options-liquidity-mining/olm-explained.md new file mode 100644 index 0000000..359004c --- /dev/null +++ b/options-liquidity-mining/olm-explained.md @@ -0,0 +1,2 @@ +# OLM Explained + diff --git a/providing-liquidity/liquidity-providing-options.md b/providing-liquidity/liquidity-providing-options.md new file mode 100644 index 0000000..91c1fc0 --- /dev/null +++ b/providing-liquidity/liquidity-providing-options.md @@ -0,0 +1,2 @@ +# Liquidity Providing Options + diff --git a/providing-liquidity/why-provide-liquidity.md b/providing-liquidity/why-provide-liquidity.md new file mode 100644 index 0000000..fa89654 --- /dev/null +++ b/providing-liquidity/why-provide-liquidity.md @@ -0,0 +1,2 @@ +# Why Provide Liquidity? + diff --git a/swap-assets/fixed-forexs-ibamm.md b/swap-assets/fixed-forexs-ibamm.md new file mode 100644 index 0000000..9c371ab --- /dev/null +++ b/swap-assets/fixed-forexs-ibamm.md @@ -0,0 +1,2 @@ +# Fixed Forex's ibAMM + diff --git a/swap-assets/using-curve.md b/swap-assets/using-curve.md new file mode 100644 index 0000000..0d7a2b6 --- /dev/null +++ b/swap-assets/using-curve.md @@ -0,0 +1,2 @@ +# Using Curve + diff --git a/swap-assets/using-synthetix.md b/swap-assets/using-synthetix.md new file mode 100644 index 0000000..c3b41a3 --- /dev/null +++ b/swap-assets/using-synthetix.md @@ -0,0 +1,2 @@ +# Using Synthetix + diff --git a/usdkp3r-token/understanding-usdkp3r.md b/usdkp3r-token/understanding-usdkp3r.md new file mode 100644 index 0000000..a320b37 --- /dev/null +++ b/usdkp3r-token/understanding-usdkp3r.md @@ -0,0 +1,2 @@ +# Understanding $KP3R + diff --git a/usdkp3r-token/usdkp3r-faq.md b/usdkp3r-token/usdkp3r-faq.md new file mode 100644 index 0000000..33a443d --- /dev/null +++ b/usdkp3r-token/usdkp3r-faq.md @@ -0,0 +1,2 @@ +# $KP3R FAQ + diff --git a/usdkp3r-token/usdkp3r-tokenomics.md b/usdkp3r-token/usdkp3r-tokenomics.md new file mode 100644 index 0000000..e8808d5 --- /dev/null +++ b/usdkp3r-token/usdkp3r-tokenomics.md @@ -0,0 +1,2 @@ +# $KP3R Tokenomics + diff --git a/vesting/benefits-of-vesting.md b/vesting/benefits-of-vesting.md new file mode 100644 index 0000000..a2173d1 --- /dev/null +++ b/vesting/benefits-of-vesting.md @@ -0,0 +1,2 @@ +# Benefits of Vesting + diff --git a/vesting/how-to-vest.md b/vesting/how-to-vest.md new file mode 100644 index 0000000..bf0ba08 --- /dev/null +++ b/vesting/how-to-vest.md @@ -0,0 +1,2 @@ +# How to Vest + diff --git a/vesting/how-vesting-works.md b/vesting/how-vesting-works.md new file mode 100644 index 0000000..7c3346c --- /dev/null +++ b/vesting/how-vesting-works.md @@ -0,0 +1,2 @@ +# How Vesting Works +