Skip to content

Commit 84985f6

Browse files
Awaneesh03projectbermudaofficial-cpurohan-pandeyy
authored
Improve mkdocs navigation structure (#1276)
* docs: improve mkdocs navigation structure * fix: correct mkdocs top-level navigation structure * fix: correct YAML indentation in mkdocs nav * Fix identation and architecture diagram links --------- Co-authored-by: projectbermudaofficial <projectbermudaofficial@gmail.com> Co-authored-by: ROHAN PANDEY <95585299+rohan-pandeyy@users.noreply.github.com>
1 parent d1f22a2 commit 84985f6

2 files changed

Lines changed: 23 additions & 16 deletions

File tree

docs/overview/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This combination allows us to leverage web technologies for the UI while benefit
1616

1717
<!-- markdownlint-disable MD033 -->
1818
<div style="text-align: center;">
19-
<img src="../assets/backend-architecture.jpeg" alt="Backend Architecture" style="width: 80%; max-width: 600px; height: auto; display: block; margin: 0 auto;">
19+
<img src="../../assets/backend-architecture.jpeg" alt="Backend Architecture" style="width: 80%; max-width: 600px; height: auto; display: block; margin: 0 auto;">
2020
</div>
2121

2222
<br>

mkdocs.yml

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ site_name: PictoPy
22
repo_name: AOSSIE-Org/PictoPy
33
repo_url: https://github.com/AOSSIE-Org/PictoPy
44
edit_uri: edit/main/docs/
5-
65
theme:
76
name: material
87
logo: assets/favicon.png
@@ -39,7 +38,6 @@ theme:
3938
plugins:
4039
- search
4140
- swagger-ui-tag:
42-
4341

4442
markdown_extensions:
4543
- pymdownx.highlight:
@@ -60,19 +58,28 @@ extra_css:
6058
- stylesheets/extra.css
6159

6260
nav:
63-
- Home:
64-
- Introduction: index.md
65-
- Overview: overview/features.md
66-
- Setup: setup.md
67-
- Backend:
68-
- Python Backend API: backend/backend_python/api.md
69-
- Python Backend Database: backend/backend_python/database.md
70-
- Python Backend Directory Structure: backend/backend_python/directory-structure.md
71-
- Python Backend Image Processing: backend/backend_python/image-processing.md
72-
- Rust Backend API: backend/backend_rust/api.md
73-
- Frontend:
74-
- State Management: frontend/state-management.md
75-
- Screenshots: frontend/screenshots.md
61+
- Home: index.md
62+
63+
- Overview:
64+
- Features: overview/features.md
65+
- Architecture: overview/architecture.md
66+
67+
- Setup:
68+
- Overview: setup.md
69+
- Manual Setup Guide: Manual_Setup_Guide.md
70+
- Script Setup Guide: Script_Setup_Guide.md
71+
72+
- Backend:
73+
- Python Backend API: backend/backend_python/api.md
74+
- Python Backend Database: backend/backend_python/database.md
75+
- Python Backend Directory Structure: backend/backend_python/directory-structure.md
76+
- Python Backend Image Processing: backend/backend_python/image-processing.md
77+
- Rust Backend API: backend/backend_rust/api.md
78+
79+
- Frontend:
80+
- State Management: frontend/state-management.md
81+
- Memories: frontend/memories.md
82+
- Screenshots: frontend/screenshots.md
7683

7784
extra:
7885
social:

0 commit comments

Comments
 (0)