Add updated Charli3 Dendrite Documentation

Charli3-Official · Aug 22, 2024 · dd2dff0 · dd2dff0
1 parent 484513e
commit dd2dff0
Show file tree

Hide file tree

Showing 36 changed files with 654 additions and 10 deletions.
diff --git a/docs/amm_base.md b/docs/amm_base.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.amm_base
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/axo.md b/docs/axo.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.ob.axo
diff --git a/docs/backend_base.md b/docs/backend_base.md
@@ -0,0 +1 @@
+::: charli3_dendrite.backend.backend_base
diff --git a/docs/core_base.md b/docs/core_base.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.core.base
diff --git a/docs/datums.md b/docs/datums.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dataclasses.datums
diff --git a/docs/dbsync_models.md b/docs/dbsync_models.md
@@ -0,0 +1 @@
+::: charli3_dendrite.backend.dbsync.models
diff --git a/docs/errors.md b/docs/errors.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.core.errors
diff --git a/docs/geniusyield.md b/docs/geniusyield.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.ob.geniusyield
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,33 @@
+# Welcome to Charli3 Dendrite Documentation
+
+Get ready to dive into the incredible world of decentralized exchanges (DEXs) on the Cardano blockchain! With Charli3 Dendrite, we've integrated some of the most exciting and innovative DEXs out there, each offering unique features that are transforming the way we trade and manage liquidity on Cardano.
+
+## Supported DEXs
+
+### [Vyfi](https://vyfi.io)
+  - **VyFi (VyFinance)** is nothing short of a game-changer on Cardano! This all-in-one DeFi platform delivers a powerhouse of tools, including a top-notch DEX and yield farming opportunities that cater to both newbies and seasoned pros. VyFi is your gateway to unlocking the full potential of DeFi on Cardano!
+
+### [Minswap](https://minswap.org)
+  - **Minswap** is where simplicity meets power on Cardano. As a community-driven AMM DEX, Minswap makes trading tokens and earning rewards a breeze. Whether you're new to DeFi or a veteran, Minswap's user-friendly design and robust features make it an essential stop on your Cardano journey.
+
+### [Muesliswap](https://muesliswap.com)
+  - **MuesliSwap** is not just any DEX; it's a trailblazer as the first order book-based DEX on Cardano! With MuesliSwap, you're in control, placing orders directly on the blockchain for a truly unique and hands-on trading experience. Step away from the AMM crowd and discover the distinct advantages of MuesliSwap!
+
+### [Spectrum](https://spectrum.fi)
+  - **Spectrum** (formerly ErgoDEX) is revolutionizing the cross-chain world by seamlessly connecting the Cardano and Ergo blockchains. With Spectrum, you can execute secure and efficient token swaps across networks, expanding your reach and enhancing interoperability like never before. This is the future of cross-chain trading!
+
+### [Sundae](https://sundaeswap.finance)
+  - **SundaeSwap** has quickly become a fan favorite among Cardano users, and it's easy to see why! This AMM DEX is as sweet as its name, offering an intuitive interface for token swaps and liquidity provision. SundaeSwap's vibrant community and user-centric approach make it the perfect choice for anyone looking to get the most out of Cardano's DeFi ecosystem.
+
+### [Wingriders](https://wingriders.com)
+  - **WingRiders** takes performance to new heights! This high-speed AMM DEX on Cardano is all about delivering deep liquidity and lightning-fast transaction speeds, making it a go-to platform for traders looking to move large volumes with efficiency and ease. Fly high with WingRiders and experience trading like never before!
+
+### [Axo](https://www.axo.trade/)
+  - **Axo** is where advanced trading meets cutting-edge technology on Cardano. Designed for the serious trader, Axo offers customizable strategies and high-performance order execution that cater to both retail and institutional users. If you're looking to elevate your trading game, Axo is your new best friend!
+
+### [Genius Yield](https://www.geniusyield.co/)
+  - **Genius Yield** is not just a DEX; it's a smart liquidity management powerhouse on Cardano! By combining a DEX with intelligent yield optimization, Genius Yield helps you maximize your returns while enjoying a seamless and sophisticated trading experience. Get ready to be amazed by the future of DeFi with Genius Yield!
+
+## Special Thanks
+
+A huge shoutout to [SteelSwap](https://steelswap.io) for their incredible collaboration and unwavering support in making Charli3 Dendrite a reality. SteelSwap has been a cornerstone in this project, and we couldn't have done it without them. Here's to the exciting future we're building together!
diff --git a/docs/minswap.md b/docs/minswap.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.minswap
diff --git a/docs/models.md b/docs/models.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dataclasses.models
diff --git a/docs/muesliswap.md b/docs/muesliswap.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.muesli
diff --git a/docs/order_book_base.md b/docs/order_book_base.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.ob.ob_base
diff --git a/docs/spectrum.md b/docs/spectrum.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.spectrum
diff --git a/docs/sundae.md b/docs/sundae.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.sundae
diff --git a/docs/types.md b/docs/types.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.amm_types
diff --git a/docs/utils.md b/docs/utils.md
@@ -0,0 +1 @@
+::: charli3_dendrite.backend.utils
diff --git a/docs/vyfi.md b/docs/vyfi.md
@@ -0,0 +1,2 @@
+::: charli3_dendrite.dexs.amm.vyfi
+
diff --git a/docs/wingriders.md b/docs/wingriders.md
@@ -0,0 +1 @@
+::: charli3_dendrite.dexs.amm.wingriders
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,73 @@
+# Site Information
+site_name: Charli3 Dendrite
+site_url: https://charli3.io/
+site_description: "Documentation for the Charli3 Dendrite project."
+repo_url: https://github.com/Charli3-Official/charli3-dendrite
+repo_name: 'Charli3-Official/charli3-dendrite'
+edit_uri: https://github.com/Charli3-Official/charli3-dendrite/edit/master/docs/
+
+theme:
+  name: material
+  locale: en
+  include_sidebar: true
+  shortcuts:
+    help: 191    # ?
+    next: 78     # n
+    previous: 80 # p
+    search: 83   # s
+
+nav:
+  - Home: index.md
+  - DEXs:
+      - Automated Market Maker:
+          - amm_base.md
+          - types.md
+          - Modules:
+              - Vyfi: vyfi.md
+              - Minswap: minswap.md
+              - Muesliswap: muesliswap.md
+              - Spectrum: spectrum.md
+              - Sundae: sundae.md
+              - Wingriders: wingriders.md
+      - Order Book:
+          - order_book_base.md
+          - Modules:
+              - Axo: axo.md
+              - Genius Yield: geniusyield.md
+      - Core:
+          - core_base.md
+          - errors.md
+  - Backend:
+      - Backend Base: backend_base.md
+      - Utils: utils.md
+      - DBsync:
+          - Models: dbsync_models.md
+  - Data Classes:
+      - Datums: datums.md
+      - Models: models.md
+
+plugins:
+  - search
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          setup_commands:
+            - "import sys; sys.path.insert(0, 'src')"
+          rendering:
+            show_source: true
+            show_root_toc_entry: false
+
+theme:
+  name: material
+  palette:
+    primary: 'red'
+    accent: 'pink'
+  font:
+    text: 'Roboto'
+    code: 'Roboto Mono'
+
+watch:
+  - src
+extra:
+  version: 1.0