Merge pull request #6 from CoinFabrik/feat/restructure-part-1

Docs Restructure (Part 1)

.gitbook.yaml

@@ -7,3 +7,5 @@ redirects:
   product-features/farm: product-features/farming/README.md
   product-features/farm/self-service-farming: product-features/self-service-farming.md
   how-to/farm-and-harvest: product-features/farming/how-to.md
+  product-features/stake: product-features/staking/README.md
+  how-to/stake-usdalex: product-features/staking/README.md

README.md

@@ -1,5 +1,5 @@
 ---
-cover: .gitbook/assets/alex_doc_cover.jpg
+cover: .gitbook/assets/alexlab_doc_cover.jpg
 coverY: 0
 ---
 
@@ -22,4 +22,4 @@ ALEX offers a suite of DeFi opportunities that includes:
 
 Just as Bitcoin is the “gold standard” of crypto, ALEX will become gold standard of DeFi.
 
-<figure><img src=".gitbook/assets/image (13).png" alt=""><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/alexlab_landing_page.png" alt=""><figcaption></figcaption></figure>

SUMMARY.md

@@ -2,66 +2,48 @@
 
 * [What is ALEX](README.md)
 
-## Product/ Features
+## Features
 
 * [🔄 Token Swaps](product-features/token-swaps/README.md)
-  * [Key concepts](product-features/token-swaps/key-concepts.md)
-  * [How to swap](product-features/token-swaps/how-to.md)
-  * [FAQs](product-features/token-swaps/faqs.md)
+  * [💡 Key concepts](product-features/token-swaps/key-concepts.md)
+  * [🧑‍🏫 How to swap](product-features/token-swaps/how-to.md)
+  * [❓ FAQs](product-features/token-swaps/faqs.md)
 * [🐋 Liquidity Providers](product-features/liquidity-providers/README.md)
-  * [Key concepts](product-features/liquidity-providers/key-concepts.md)
-  * [How to add/remove liquidity](product-features/liquidity-providers/how-to.md)
-  * [FAQs](product-features/liquidity-providers/faqs.md)
+  * [💡 Key concepts](product-features/liquidity-providers/key-concepts.md)
+  * [🧑‍🏫 How to add/remove liquidity](product-features/liquidity-providers/how-to.md)
+  * [❓ FAQs](product-features/liquidity-providers/faqs.md)
   * [📝 Self-Service Listing](product-features/self-service-listing.md)
 * [🌾 Farming](product-features/farming/README.md)
-  * [Key concepts](product-features/farming/key-concepts.md)
-  * [How to farm & harvest](product-features/farming/how-to.md)
-  * [FAQs](product-features/farming/faqs.md)
+  * [💡 Key concepts](product-features/farming/key-concepts.md)
+  * [🧑‍🏫 How to farm & harvest](product-features/farming/how-to.md)
+  * [❓ FAQs](product-features/farming/faqs.md)
   * [🧑‍🌾 Self-Service Farming](product-features/self-service-farming.md)
-* [⚓ Stake](product-features/stake.md)
+* [⚓ Stake](product-features/staking/README.md)
+  * [💡 Key concepts](product-features/staking/key-concepts.md)
+  * [🧑‍🏫 How to stake](product-features/staking/how-to.md)
+  * [❓ FAQs](product-features/staking/faqs.md)
 * [🚀 Launchpad](product-features/launchpad.md)
 * [📈 Analytics](product-features/analytics.md)
 
-## Tokenomics
+## Resources
 
-* [🪙 Tokenomics](tokenomics/tokenomics.md)
-
-## How To
-
-* [👉 Set up Hiro Wallet](how-to/set-up-hiro-wallet.md)
-* [⚓ Stake $ALEX](how-to/stake-usdalex/README.md)
-  * [How to Use Auto Staking (minting AutoALEX)](how-to/stake-usdalex/how-to-use-auto-staking-minting-autoalex.md)
-  * [How to Use Manual (Customized) Staking](how-to/stake-usdalex/how-to-use-manual-customized-staking.md)
-* [💰 Lend & Borrow](how-to/lend-and-borrow/README.md)
-  * [🏦 How To Lend](how-to/lend-and-borrow/how-to-lend.md)
-  * [💸 How To Borrow](how-to/lend-and-borrow/how-to-borrow.md)
-* [✅ Security Audit](how-to/security-audit.md)
-* [🔗 Official Links](how-to/official-links.md)
-
-***
-
-* [Token List](token-list/README.md)
+* [🔗 Official Links](resources/official-links.md)
+* [✅ Security Audit](resources/security-audit.md)
+* 🪙 Token List
   * [$SLIME](token-list/usdslime.md)
-  * [$MIA & $NYC](token-list/usdmia-and-usdnyc.md)
+  * [\$MIA & \$NYC](token-list/usdmia-and-usdnyc.md)
   * [$USDA](token-list/usdusda.md)
   * [$BANANA](token-list/usdbanana.md)
   * [$xBTC](token-list/usdxbtc.md)
   * [$xUSD](token-list/usdxusd.md)
-
-## White Papers
-
-* [📃 Whitepaper (1): Automated Market Making of the Yield Token Pool](white-papers/whitepaper-1-automated-market-making-of-the-yield-token-pool.md)
-* [📃 Whitepaper (2): Automated Market Making of the Collateral Rebalancing Pooltitled](white-papers/whitepaper-2-automated-market-making-of-the-collateral-rebalancing-pooltitled.md)
-* [📃 Whitepaper (3): Diving into Collateral Rebalancing Pools!](white-papers/whitepaper-3-diving-into-collateral-rebalancing-pools.md)
-
-## Security Audit & Bug Bounty
-
-* [Security Audit (1): CoinFabrik Security Review:](security-audit-and-bug-bounty/security-audit-1-coinfabrik-security-review.md)
-* [Security Audit (2): CoinFabrik Launchpad Vault and Reserv-Pool audit](security-audit-and-bug-bounty/security-audit-2-coinfabrik-launchpad-vault-and-reserv-pool-audit.md)
-* [Bug Bounty](security-audit-and-bug-bounty/bug-bounty.md)
+* 📃 Whitepapers
+  * [Whitepaper (1): Automated Market Making of the Yield Token Pool](whitepapers/whitepaper-1-automated-market-making-of-the-yield-token-pool.md)
+  * [Whitepaper (2): Automated Market Making of the Collateral Rebalancing Pooltitled](whitepapers/whitepaper-2-automated-market-making-of-the-collateral-rebalancing-pooltitled.md)
+  * [Whitepaper (3): Diving into Collateral Rebalancing Pools!](whitepapers/whitepaper-3-diving-into-collateral-rebalancing-pools.md)
 
 ## Detailed Information
 
-* [ALEX’s Automated Market Maker (AMM)](detailed-information/alexs-automated-market-maker-amm.md)
-* [What is ALEX Staking Power and How do I use it?](detailed-information/what-is-alex-staking-power-and-how-do-i-use-it.md)
+* [Tokenomics](detailed-information/tokenomics.md)
 * [ALEX DAO](detailed-information/alex-dao.md)
+* [ALEX AMM](detailed-information/alexs-automated-market-maker-amm.md)
+* [ALEX APower](detailed-information/what-is-alex-staking-power-and-how-do-i-use-it.md)

how-to/security-audit.md

@@ -1,11 +0,0 @@
-# ✅ Security Audit
-
-ALEX has reached out to two security audit firms for a complete smart contract and code audit.
-
-[CoinFabrik ](https://www.coinfabrik.com/)and [Least Authority](https://leastauthority.com/) audit report is available for a full review here.
-
-We are also working with some of our top community security and smart contract experts like Hank & Jeff from Oby and the folks from [Syvita Guild](https://syvita.org/).
-
-### Immunefi Bounty Program
-
-If you are interested in participating ALEX bug bounty program, please head to [this page](broken-reference) to learn more.

product-features/farming/README.md

@@ -17,7 +17,7 @@ layout:
 
 Yield Farming on ALEX is an excellent way to earn exciting returns. By farming (staking or locking up your LP tokens), you earn rewards in addition to the earnings from being a liquidity provider. Among these rewards are $ALEX tokens, APower tokens, and tokens provided by the project.
 
-To get started with farming, you first deposit two tokens into a liquidity pool, receiving LP tokens in return. Then, you stake these LP tokens in a farm, allowing you to harvest rewards after each staking cycle while still benefiting from the trading fees generated by the pool.
+To get started with farming, you first deposit two tokens into a liquidity pool, receiving LP tokens in return. Then, you stake these LP tokens in a farm, allowing you to harvest rewards after each farming cycle while still benefiting from the trading fees generated by the pool.
 
 {% hint style="info" %}
 **What are LP tokens?** LP tokens represent your share of a liquidity pool as a liquidity provider. These tokens entitle you to a portion of the pool's assets and a share of the fees generated by trades (swaps) in the pool. Learn more on the [Key Concepts](key-concepts.md) page.

product-features/farming/faqs.md

@@ -87,6 +87,8 @@ APower is the access token for participating in the "Community Round" of any fut
 
 Every IDO is unique, however, and may have a cap on the amount of APower that can be utilized to allocate IDO tickets. This prevents IDOs from being dominated by a small group of "whale" members.
 
+Full Medium post [here](https://medium.com/alexgobtc/what-is-alex-staking-power-and-how-do-i-use-it-1b3de3797fa2).
+
 </details>
 
 <details>

product-features/farming/how-to.md

@@ -189,7 +189,7 @@ Happy Farming! 🥕 🥬 🍅
 
 Withdrawing you LP tokens takes just a few steps. The important thing is when to do it.
 
-When farming, you commit to locking up your tokens for a predefined period (reward cycles, each cycle contains 525 Stacks blocks, an estimation of ~3.5 days per cycle). Once these cycles conclude, you will be able to unstake them and regain control over your LP tokens.
+When farming, you are committed to locking up your tokens for a predefined period (reward cycles, each cycle contains 525 Stacks blocks, an estimation of ~3.5 days per cycle). Once these cycles conclude, you will be able to unstake them and regain control over your LP tokens.
 
 If you staked multiple times at different moments, the lock periods apply to each amount separately.
 

product-features/farming/key-concepts.md

@@ -8,7 +8,7 @@ description: >-
 
 ## Farm basics
 
-Yield farming works very similar to standard staking, with the key difference being that the tokens you stake are LP tokens. As in traditional staking, you lock up your tokens for a certain period (measured in cycles) and earn rewards over time. After each cycle, you will have rewards available to harvest[^1].
+Yield farming works in a very similar way to standard staking, with the key difference being that the tokens you stake are LP tokens. As in traditional staking, you lock up your tokens for a certain period (measured in cycles) and earn rewards over time. After each cycle, you will have rewards available to harvest[^1].
 
 ### What are LP tokens?
 

product-features/stake.md

@@ -1,13 +0,0 @@
-# ⚓ Stake
-
-ALEX staking involves “locking up” your $ALEX token on the platform for an amount of time (”rewards cycles”) in exchange for earning protocol rewards. 
-
-You can think of $ALEX staking as depositing money into an interest-earning account. The longer you keep the money in the account the more interest you earn. Similarly, the longer you stake $ALEX the more rewards you earn.
-
-ALEX provides manual(Customized) ALEX Staking. 
-
-Lisa Protocol([https://www.lisalab.io/](https://www.lisalab.io/)) is now providing liquid staking for ALEX Staking ($LiALEX) 
-
-The protocol rewards are provided in the form of more $ALEX as well as [$APower](https://medium.com/alexgobtc/what-is-alex-staking-power-and-how-do-i-use-it-1b3de3797fa2) which is only available to stakers to be used in the ALEX launchpad.
-
-<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption><p>ALEX Staking</p></figcaption></figure>

product-features/staking/README.md

@@ -0,0 +1,25 @@
+# ⚓ Stake
+
+ALEX staking involves “locking up” your $ALEX token on the platform for an amount of time (”rewards cycles”) in exchange for earning protocol rewards. 
+
+You can think of \$ALEX staking as depositing money into an interest-earning account. The longer you keep the money in the account the more interest you earn. Similarly, the longer you stake $ALEX the more rewards you earn.
+
+ALEX provides manual(Customized) ALEX Staking. 
+
+Lisa Protocol([https://www.lisalab.io/](https://www.lisalab.io/)) is now providing liquid staking for ALEX Staking ($LiALEX) 
+
+The protocol rewards are provided in the form of more $ALEX as well as [\$APower](https://medium.com/alexgobtc/what-is-alex-staking-power-and-how-do-i-use-it-1b3de3797fa2) which is only available to stakers to be used in the ALEX launchpad.
+
+<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption><p>ALEX Staking</p></figcaption></figure>
+
+<!-- 
+
+## Choose where to start
+
+<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>Key concepts</td><td><a href="key-concepts.md">key-concepts.md</a></td><td><a href="../../.gitbook/assets/cards/key-concepts.png">cards/key-concepts.png</a></td></tr><tr><td>How to stake</td><td><a href="how-to.md">how-to.md</a></td><td><a href="../../.gitbook/assets/cards/how-to.png">cards/how-to.png</a></td></tr><tr><td>FAQs</td><td><a href="faqs.md">faqs.md</a></td><td><a href="../../.gitbook/assets/cards/faqs.png">cards/faqs.png</a></td></tr></tbody></table>
+
+## Support
+
+For assistance, please reach out to our Community Managers on [Discord](https://discord.com/invite/alexlab) and [Telegram Channel](https://t.me/AlexCommunity).  
+
+-->

product-features/staking/faqs.md

@@ -0,0 +1,3 @@
+# FAQs
+
+Comming soon.

product-features/staking/how-to.md

@@ -0,0 +1,3 @@
+# How to stake on ALEX
+
+Comming soon.

product-features/staking/key-concepts.md

@@ -0,0 +1,3 @@
+# Key concepts
+
+Comming soon.

resources/security-audit.md

@@ -0,0 +1,18 @@
+# ✅ Security Audit
+
+ALEX has reached out to two security audit firms for a complete smart contract and code audit.
+
+[CoinFabrik](https://www.coinfabrik.com/) and [Least Authority](https://leastauthority.com/) audit report is available for a full review here.
+
+We are also working with some of our top community security and smart contract experts like Hank & Jeff from Oby and the folks from [Syvita Guild](https://syvita.org/).
+
+Check the audit reports here:
+
+- [Security Audit (1): CoinFabrik Security Review](https://drive.google.com/file/d/1sCxr-H\_NpnN-nZ8GPdi\_l7eGgtlBaxuz/view)
+- [Security Audit (2): CoinFabrik Launchpad Vault and Reserv-Pool](https://blog.coinfabrik.com/smart-contract-audit/alexgo-audit-launchpad-vault-and-reserve-pool/)
+
+## Immunefi Bounty Program
+
+If you are interested in participating ALEX bug bounty program, please head to [https://immunefi.com/bounty/alex/](https://immunefi.com/bounty/alex/) to learn more.
+
+

token-list/README.md

@@ -1,2 +0,0 @@
-# Token List
-