docs: organize tutorials, add awesome badge

MadeInPierre · Jun 8, 2023 · 62b249d · 62b249d
1 parent a57f996
commit 62b249d
Show file tree

Hide file tree

Showing 14 changed files with 17 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -7,13 +7,13 @@
 
 <div align="center">
   <h4>Minimalistic command-line tool to help you manage your investments</h4>
-
-  <sub>Built with ❤︎ by <a href="https://www.buymeacoffee.com/MadeInPierre">Pierre Laclau</a> and <a href="https://github.com/MadeInPierre/finalynx/graphs/contributors">contributors</a>. Logo generated by <a href="https://midjourney.com">Midjourney</a>.</sub>
-
-  <br><a href="https://pypi.org/project/finalynx/"><img alt="PyPI" src="https://img.shields.io/pypi/v/finalynx?style=flat-square"></a>
+  <a href="https://pypi.org/project/finalynx/"><img alt="PyPI" src="https://img.shields.io/pypi/v/finalynx?style=flat-square"></a>
   <a href="https://github.com/MadeInPierre/finalynx/actions/workflows/semantic-release.yml"><img alt="GitHub Workflow Status (main)" src="https://img.shields.io/github/actions/workflow/status/madeinpierre/finalynx/semantic-release.yml?branch=main&style=flat-square"></a>
   <a href="https://github.com/MadeInPierre/finalynx/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/madeinpierre/finalynx?style=flat-square"></a>
   <a href="https://github.com/sponsors/MadeInPierre"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/MadeInPierre?style=flat-square"></a>
+  <a href="https://github.com/finary-wealth/awesome"><img alt="Mentioned in Awesome Finary" src="https://awesome.re/mentioned-badge-flat.svg"></a>
+
+  <sub>Built with ❤︎ by <a href="https://www.buymeacoffee.com/MadeInPierre">Pierre Laclau</a> and <a href="https://github.com/MadeInPierre/finalynx/graphs/contributors">contributors</a>. Logo generated by <a href="https://midjourney.com">Midjourney</a>.</sub>
 
   <br>
 </div>

diff --git a/docs/quickstart/tutorials.md b/docs/quickstart/tutorials.md
@@ -4,20 +4,21 @@ Looking for a step-by-step guide to understand each concept available in Finalyn
 
 ## 1. Basics
 Learn how to use the general tool's features before diving into your investments portfolio:
-- [**Tutorial 1:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_minimal.py) Minimal configuration
-- [**Tutorial 2:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/2_theme.py) Set your console theme
-- [**Tutorial 3:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/3_login.py) Control login & cache
-- [**Tutorial 4:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/4_export.py) Exporting to JSON
-- [**Tutorial 5:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/5_display_options.py) Console display options
-- [**Tutorial 6:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/6_dashboard.py) Launching the dashboard
+- [**Tutorial 1:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/1_minimal.py) Minimal configuration
+- [**Tutorial 2:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/2_theme.py) Set your console theme
+- [**Tutorial 3:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/3_login.py) Control login & cache
+- [**Tutorial 4:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/4_export.py) Exporting to JSON
+- [**Tutorial 5:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/5_display_options.py) Console display options
+- [**Tutorial 6:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/6_dashboard.py) Launching the dashboard
+- [**Tutorial 7:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/1_basics/7_sources.py) Fetch from other sources than Finary
 
 ## 2. Portfolio
 Now, you can set your own portfolio tree and watch your structure be built once you run Finalynx!
-- [**Tutorial 7:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/7_structure.py) Define your portfolio structure
-- [**Tutorial 8:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/8_buckets.py) Buckets
-- [**Tutorial 9:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/9_attributes.py) Asset classes and expected performance
-- [**Tutorial 10:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/10_targets.py) Targets
-- [**Tutorial 11:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/11_envelopes.py) Envelopes
+- [**Tutorial 8:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/2_portfolio/8_structure.py) Define your portfolio structure
+- [**Tutorial 9:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/2_portfolio/9_buckets.py) Buckets
+- [**Tutorial 10:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/2_portfolio/10_attributes.py) Asset classes and expected performance
+- [**Tutorial 11:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/2_portfolio/11_targets.py) Targets
+- [**Tutorial 12:**](https://github.com/MadeInPierre/finalynx/blob/main/examples/tutorials/2_portfolio/12_envelopes.py) Envelopes
 
 Check back soon for more features, or [contribute](https://finalynx.readthedocs.io/en/latest/project/contributing.html) to see them appear here! 😄
 

diff --git a/examples/tutorials/1_minimal.py → examples/tutorials/1_basics/1_minimal.py b/examples/tutorials/1_minimal.py → examples/tutorials/1_basics/1_minimal.py
diff --git a/examples/tutorials/2_theme.py → examples/tutorials/1_basics/2_theme.py b/examples/tutorials/2_theme.py → examples/tutorials/1_basics/2_theme.py
diff --git a/examples/tutorials/3_login.py → examples/tutorials/1_basics/3_login.py b/examples/tutorials/3_login.py → examples/tutorials/1_basics/3_login.py
diff --git a/examples/tutorials/4_export.py → examples/tutorials/1_basics/4_export.py b/examples/tutorials/4_export.py → examples/tutorials/1_basics/4_export.py
diff --git a/examples/tutorials/5_display_options.py → ...s/tutorials/1_basics/5_display_options.py b/examples/tutorials/5_display_options.py → ...s/tutorials/1_basics/5_display_options.py
diff --git a/examples/tutorials/6_dashboard.py → examples/tutorials/1_basics/6_dashboard.py b/examples/tutorials/6_dashboard.py → examples/tutorials/1_basics/6_dashboard.py
diff --git a/examples/tutorials/11_envelopes.py → examples/tutorials/1_basics/7_sources.py b/examples/tutorials/11_envelopes.py → examples/tutorials/1_basics/7_sources.py
diff --git a/examples/tutorials/9_attributes.py → ...es/tutorials/2_portfolio/10_attributes.py b/examples/tutorials/9_attributes.py → ...es/tutorials/2_portfolio/10_attributes.py
diff --git a/examples/tutorials/10_targets.py → examples/tutorials/2_portfolio/11_targets.py b/examples/tutorials/10_targets.py → examples/tutorials/2_portfolio/11_targets.py
diff --git a/examples/tutorials/2_portfolio/12_envelopes.py b/examples/tutorials/2_portfolio/12_envelopes.py
@@ -0,0 +1 @@
+# TODO Coming soon!
diff --git a/examples/tutorials/7_structure.py → ...ples/tutorials/2_portfolio/8_structure.py b/examples/tutorials/7_structure.py → ...ples/tutorials/2_portfolio/8_structure.py
diff --git a/examples/tutorials/8_buckets.py → examples/tutorials/2_portfolio/9_buckets.py b/examples/tutorials/8_buckets.py → examples/tutorials/2_portfolio/9_buckets.py