Skip to content

DOC: Update backend routes directory structure documentation#1367

Open
Dotify71 wants to merge 2 commits into
AOSSIE-Org:mainfrom
Dotify71:docs/fix-routes-directory-structure
Open

DOC: Update backend routes directory structure documentation#1367
Dotify71 wants to merge 2 commits into
AOSSIE-Org:mainfrom
Dotify71:docs/fix-routes-directory-structure

Conversation

@Dotify71

@Dotify71 Dotify71 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

This PR updates the Routes table in docs/backend/backend_python/directory-structure.md to accurately reflect the current state of the backend/app/routes/ directory.

Changes

  • Removed facetagging.py from the documentation, as the file no longer exists in the codebase.
  • Added memories.py, detailing the endpoints for generating location and time-based photo memories.
  • Added models.py, documenting the endpoints used for AI model management (download status, hardware recommendations, setup, and deletion).
  • Added shutdown.py, covering the endpoint responsible for gracefully terminating the backend process.

(Note: test.py was intentionally omitted since its contents are currently commented out and it does not register an active router.)

This addresses the scoped documentation improvements confirmed in the issue discussion.

Closes #1257

Summary by CodeRabbit

  • Documentation
    • Updated backend directory documentation to reflect the current set of route modules.
    • Added references to new route modules and revised descriptions for existing ones.
    • Removed an outdated route entry from the documented structure.

…ture

The Routes table in docs/backend/backend_python/directory-structure.md
was outdated in two ways:

- facetagging.py was listed but no longer exists in backend/app/routes/
- memories.py, models.py, and shutdown.py were active route files that
  were missing from the table entirely

This commit:
- Removes the stale facetagging.py entry
- Adds memories.py with a description based on its Memories API docstring
- Adds models.py with a description based on its model management endpoints
- Adds shutdown.py with a description based on its graceful shutdown logic

No code changes were made. This is a documentation-only correction.

Related to AOSSIE-Org#1257
@github-actions github-actions Bot added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: db51dd05-4ccd-4d38-b83d-4b7fe3a16bf5

📥 Commits

Reviewing files that changed from the base of the PR and between 54698b7 and c7d9dd5.

📒 Files selected for processing (1)
  • docs/backend/backend_python/directory-structure.md
✅ Files skipped from review due to trivial changes (1)
  • docs/backend/backend_python/directory-structure.md

Walkthrough

Updated the backend directory-structure documentation to reflect current route modules by adding new entries, removing an obsolete one, and revising several existing descriptions.

Changes

Routes documentation update

Layer / File(s) Summary
Update routes table entries
docs/backend/backend_python/directory-structure.md
Added rows for memories.py, models.py, and shutdown.py, revised descriptions for face_clusters.py and folders.py, and removed the facetagging.py row.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested labels: Documentation

Poem

A hop through docs, so tidy and neat,
New routes added, old ones deplete,
🐇 memories, models, shutdown too,
facetagging's gone, the table's anew,
Nibbling carrots as I approve this feat!

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation update to the backend routes directory structure.
Linked Issues check ✅ Passed The change matches issue #1257 by improving backend documentation structure and keeping the route list accurate.
Out of Scope Changes check ✅ Passed The PR is documentation-only and stays within the requested backend route documentation update.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 `@docs/backend/backend_python/directory-structure.md`:
- Around line 61-70: The routes table in the backend Python directory structure
doc needs reflowing to satisfy markdownlint MD060. Update the table under the
route files section so the pipe columns are consistently aligned across all
rows, especially the `Description` column entries. Keep the content unchanged
and adjust spacing in the table around the `albums.py`, `memories.py`, and
related rows to make the markdown lint clean.
🪄 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: cdd1e657-68c9-4288-a62e-036e823aaf90

📥 Commits

Reviewing files that changed from the base of the PR and between ffc0d48 and 54698b7.

📒 Files selected for processing (1)
  • docs/backend/backend_python/directory-structure.md

Comment thread docs/backend/backend_python/directory-structure.md Outdated
@Dotify71 Dotify71 changed the title docs: fix stale and missing entries in backend routes directory structure DOC: Update backend routes directory structure documentation Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Visual & Structural Improvements (Multi-assignable issue)

1 participant