Improve mkdocs navigation structure by Awaneesh03 · Pull Request #1276 · AOSSIE-Org/PictoPy

Awaneesh03 · 2026-05-23T07:15:15Z

Fixes #1257

Changes

Added Architecture page under Overview
Added Manual Setup Guide
Added Script Setup Guide
Added Memories page under Frontend
Improved documentation navigation organization

Summary by CodeRabbit

Documentation
- Reorganized navigation into clearer top-level sections: Home, Overview (now including Features and Architecture), Setup (adds Overview plus Manual and Script guides), Backend, and Frontend.
- Added a new Memories page to the Frontend docs.
- Updated the backend architecture image reference in the Overview/Architecture page.

github-actions · 2026-05-23T07:15:24Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

coderabbitai · 2026-05-23T07:15:26Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3a822449-4a45-45a5-a523-d671762b431a

📥 Commits

Reviewing files that changed from the base of the PR and between e277625 and 181402c.

📒 Files selected for processing (2)

docs/overview/architecture.md
mkdocs.yml

📝 Walkthrough

Walkthrough

mkdocs.yml's nav was reorganized into top-level groups (Home, Overview, Setup, Backend, Frontend) and docs/overview/architecture.md had its backend architecture image path corrected.

Changes

Documentation Navigation

Layer / File(s)	Summary
Navigation structure reorganization `mkdocs.yml`	The `nav` section was restructured into Home, Overview (Features, Architecture), Setup (setup.md, manual and script guides), Backend, and Frontend (adds `frontend/memories.md`).
Architecture image path update `docs/overview/architecture.md`	Updated the `img` element’s `src` for `backend-architecture.jpeg` from `../assets/...` to `../../assets/...`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

Documentation

Poem

I’m a rabbit in the docs, hopping through each line,
I group the pages tidy so the menu’s clear and fine.
Home opens the door, Overview maps the view,
Setup points the steps, Backend and Frontend too.
A tiny img path fixed — hop on, the site’s anew! 🐇✨

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: reorganizing the mkdocs.yml navigation structure into distinct top-level documentation groups.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the MkDocs site navigation to better organize documentation pages and add links to newly documented sections.

Changes:

Re-structures the “Overview” nav entry into a nested section and adds “Architecture”.
Adds setup guides and a new “Memories” page under “Frontend”.
Removes an extraneous blank/whitespace line in the YAML config.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+      - Manual Setup Guide: Manual_Setup_Guide.md
+      - Script Setup Guide: Script_Setup_Guide.md


      - Setup: setup.md
+      - Manual Setup Guide: Manual_Setup_Guide.md
+      - Script Setup Guide: Script_Setup_Guide.md


coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@mkdocs.yml`:
- Around line 62-83: The nav entries "Overview", "Setup", "Manual Setup Guide",
"Script Setup Guide", "Backend" and "Frontend" are incorrectly nested under
"Home" in mkdocs.yml; update the nav so "Home: Introduction: index.md" remains a
single top-level entry and lift "Overview", "Setup", "Manual Setup Guide",
"Script Setup Guide", "Backend" and "Frontend" out to be separate top-level
entries (each keeping their existing child pages like overview/features.md,
setup.md, backend/backend_python/api.md, frontend/state-management.md, etc.) so
the top-level hierarchy matches the PR objective.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c8bdeaf2-6401-4d2b-94f7-29e5b8cb30be

📥 Commits

Reviewing files that changed from the base of the PR and between 402f632 and 6f6ba27.

📒 Files selected for processing (1)

mkdocs.yml

github-actions · 2026-05-23T07:35:11Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

github-actions · 2026-05-23T07:35:54Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@mkdocs.yml`:
- Around line 61-64: The YAML nav root list is mis-indented causing an invalid
sequence; fix the indentation so all top-level nav entries align under the
"nav:" key (e.g., ensure "- Home: index.md" and "- Overview:" are indented the
same level as siblings under the nav key), keeping the dash-starting list items
directly under nav and not over-indented.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5a8cbf2d-2085-4c88-838d-4068b0f4bd0b

📥 Commits

Reviewing files that changed from the base of the PR and between 6f6ba27 and e277625.

📒 Files selected for processing (1)

mkdocs.yml

github-actions · 2026-05-23T07:40:20Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

rohan-pandeyy · 2026-05-23T12:57:42Z

+- Backend:
+  - Python Backend API: backend/backend_python/api.md


You've removed the rest 4 of the docs link :D ?!

rohan-pandeyy

Thanks for the contribution!

docs: improve mkdocs navigation structure

6f6ba27

Copilot AI review requested due to automatic review settings May 23, 2026 07:15

Copilot AI reviewed May 23, 2026

View reviewed changes

coderabbitai Bot requested changes May 23, 2026

View reviewed changes

Comment thread mkdocs.yml Outdated

fix: correct mkdocs top-level navigation structure

e277625

coderabbitai Bot requested changes May 23, 2026

View reviewed changes

Comment thread mkdocs.yml

fix: correct YAML indentation in mkdocs nav

dc90c68

github-actions Bot added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 23, 2026

rohan-pandeyy reviewed May 23, 2026

View reviewed changes

Fix identation and architecture diagram links

181402c

rohan-pandeyy approved these changes May 23, 2026

View reviewed changes

rohan-pandeyy merged commit 84985f6 into AOSSIE-Org:main May 23, 2026
2 of 3 checks passed

coderabbitai Bot mentioned this pull request May 30, 2026

Fix broken docs links #1075

Merged

		- Manual Setup Guide: Manual_Setup_Guide.md
		- Script Setup Guide: Script_Setup_Guide.md

		- Backend:
		- Python Backend API: backend/backend_python/api.md

Uh oh!

Uh oh!

Conversation

Awaneesh03 commented May 23, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Summary by CodeRabbit

Uh oh!

github-actions Bot commented May 23, 2026

Uh oh!

coderabbitai Bot commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Suggested labels

Poem

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented May 23, 2026

Uh oh!

github-actions Bot commented May 23, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented May 23, 2026

Uh oh!

rohan-pandeyy May 23, 2026

Choose a reason for hiding this comment

Uh oh!

rohan-pandeyy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Awaneesh03 commented May 23, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 23, 2026 •

edited

Loading