From 0811ac0ca2be91e4cfe93f1ac6b5332ef7e013eb Mon Sep 17 00:00:00 2001
From: Mateusz Pusz <mateusz.pusz@gmail.com>
Date: Sat, 16 Dec 2023 12:38:19 +0100
Subject: [PATCH] docs: project documentation layout refactored

---
 docs/appendix/mismeasure_for_measure.md |  0
 docs/appendix/release_notes.md          |  1 -
 docs/index.md                           |  6 ++++++
 docs/library_reference/core_library.md  |  7 -------
 docs/library_reference/magnitudes.md    |  0
 docs/release_notes.md                   |  1 +
 mkdocs.yml                              | 28 ++++++++++++-------------
 7 files changed, 20 insertions(+), 23 deletions(-)
 delete mode 100644 docs/appendix/mismeasure_for_measure.md
 delete mode 120000 docs/appendix/release_notes.md
 delete mode 100644 docs/library_reference/core_library.md
 delete mode 100644 docs/library_reference/magnitudes.md
 create mode 120000 docs/release_notes.md

diff --git a/docs/appendix/mismeasure_for_measure.md b/docs/appendix/mismeasure_for_measure.md
deleted file mode 100644
index e69de29b..00000000
diff --git a/docs/appendix/release_notes.md b/docs/appendix/release_notes.md
deleted file mode 120000
index 699cc9e7..00000000
--- a/docs/appendix/release_notes.md
+++ /dev/null
@@ -1 +0,0 @@
-../../CHANGELOG.md
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 7dec4ba6..c224372c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,3 +1,9 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
 # Welcome to **mp-units**!
 
 **mp-units** is a compile-time enabled feature-rich Modern C++ modular/header-only library that
diff --git a/docs/library_reference/core_library.md b/docs/library_reference/core_library.md
deleted file mode 100644
index b34d95fc..00000000
--- a/docs/library_reference/core_library.md
+++ /dev/null
@@ -1,7 +0,0 @@
-# Core Library
-
-## Concepts
-
-## Expression templates
-
-## Dimensions
diff --git a/docs/library_reference/magnitudes.md b/docs/library_reference/magnitudes.md
deleted file mode 100644
index e69de29b..00000000
diff --git a/docs/release_notes.md b/docs/release_notes.md
new file mode 120000
index 00000000..04c99a55
--- /dev/null
+++ b/docs/release_notes.md
@@ -0,0 +1 @@
+../CHANGELOG.md
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index d7830db5..fe02ec15 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -22,9 +22,10 @@ theme:
     - content.code.copy
     # - navigation.expand
     - navigation.indexes
-    - navigation.sections
-    # - navigation.tabs
+    # - navigation.sections
+    - navigation.tabs
     - navigation.footer
+    - navigation.top
     - search.highlight
     - search.share
     - search.suggest
@@ -116,8 +117,6 @@ nav:
       - Quick Start: getting_started/quick_start.md
       - Installation and Usage: getting_started/installation_and_usage.md
       - FAQ: getting_started/faq.md
-  - Blog:
-      - blog/index.md
   - User's Guide:
       - Terms and Definitions: users_guide/terms_and_definitions.md
       - Framework Basics:
@@ -150,14 +149,13 @@ nav:
           - Extending the Library: users_guide/use_cases/extending_the_library.md
       - Examples:
           - Tags Index: users_guide/examples/tags_index.md
-          - hello_units: users_guide/examples/hello_units.md
-          - avg_speed: users_guide/examples/avg_speed.md
-          - si_constants: users_guide/examples/si_constants.md
-  - Library Reference:
-      - Core Library: library_reference/core_library.md
-      - Magnitudes: library_reference/magnitudes.md
-  - Appendix:
-      - Glossary: appendix/glossary.md
-      - Mismeasure for Measure: appendix/mismeasure_for_measure.md
-      - Release Notes: appendix/release_notes.md
-      - References: appendix/references.md
+          - All Examples:
+              - hello_units: users_guide/examples/hello_units.md
+              - avg_speed: users_guide/examples/avg_speed.md
+              - si_constants: users_guide/examples/si_constants.md
+      - Appendix:
+          - Glossary: appendix/glossary.md
+          - References: appendix/references.md
+  - Blog:
+      - blog/index.md
+  - Release Notes: release_notes.md