Skip to content

Restructures intro page aligning sidebar sections#1264

Merged
rohan-pandeyy merged 4 commits into
AOSSIE-Org:mainfrom
steam-bell-92:main
May 10, 2026
Merged

Restructures intro page aligning sidebar sections#1264
rohan-pandeyy merged 4 commits into
AOSSIE-Org:mainfrom
steam-bell-92:main

Conversation

@steam-bell-92
Copy link
Copy Markdown
Contributor

@steam-bell-92 steam-bell-92 commented May 9, 2026

Addressed Issues:

Fixes #1261
Fixes #1262

Screenshots/Recordings:

Screenshot 2026-05-09 235017 Screenshot 2026-05-10 014818

AI Usage Disclosure:

  • This PR does not contain AI-generated code at all.
  • This PR contains AI-generated code. I have read the AI Usage Policy and this PR complies with this policy. I have tested the code locally and I am responsible for it.

I have used the following AI models and tools: I manually changed the code but used AI for testing and running the changes made

Checklist

  • My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • My code follows the project's code style and conventions
  • If applicable, I have made corresponding changes or additions to the documentation
  • If applicable, I have made corresponding changes or additions to tests
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contribution Guidelines
  • Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.
  • I have filled this PR template completely and carefully, and I understand that my PR may be closed without review otherwise.

Summary by CodeRabbit

  • Documentation
    • Consolidated backend docs into a single “Backend” section and added a Rust Backend API entry alongside expanded Python Backend link labels for clearer navigation.
    • Reorganized OpenAPI reference content by relocating error response schemas within the API specification to improve structure and readability.

Review Change Stack

Copilot AI review requested due to automatic review settings May 9, 2026 18:59
@github-actions github-actions Bot added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 9, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 9, 2026

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: da1d9ff5-0e16-493f-a792-7ace263f63d0

📥 Commits

Reviewing files that changed from the base of the PR and between 719f13e and 97e69f2.

📒 Files selected for processing (1)
  • docs/index.md
✅ Files skipped from review due to trivial changes (1)
  • docs/index.md

Walkthrough

Relocates four OpenAPI ErrorResponse schemas within the OpenAPI components and updates the docs index to consolidate the Rust backend API link under a unified "Backend" navigation list.

Changes

Docs + OpenAPI Reorganization

Layer / File(s) Summary
OpenAPI: relocate error schemas
docs/backend/backend_python/openapi.json
Reintroduced app__schemas__folders__ErrorResponse, app__schemas__face_clusters__ErrorResponse, app__schemas__images__ErrorResponse, and app__schemas__user_preferences__ErrorResponse under components.schemas (properties: success, message, error, with required constraints).
Docs: consolidate Backend links
docs/index.md
Changed "Backend Python" header to "Backend" and added ./backend/backend_rust/api as "Rust Backend API" inside the same unordered list; removed standalone "Backend Rust" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

Documentation

Suggested reviewers

  • rahulharpal1603

Poem

🐰 I hopped through lines of docs and schemes,
Nesting Rust where Python beams—
Four errors moved to tidy space,
One Backend list, a cleaner place.

🚥 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 main change: restructuring the introduction page and aligning sidebar sections, which directly matches the core objective of the PR.
Linked Issues check ✅ Passed The PR addresses both linked issues: #1261 (alphabetical ordering of E* schemas in OpenAPI spec) and #1262 (sidebar reorganization to match Introduction page hierarchy).
Out of Scope Changes check ✅ Passed All changes are within scope: docs/index.md restructures the sidebar to match Introduction page hierarchy, and OpenAPI.json reorders schemas alphabetically as required.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation Introduction page layout/content to better reflect the intended docs hierarchy between Backend (Python/Rust) and Frontend.

Changes:

  • Removes the dedicated “Backend Rust” column markup from docs/index.md.
  • Moves the Rust backend API link into the “Backend Python” list.
  • Adjusts the intro page’s column structure (but currently leaves the HTML column nesting unbalanced).

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

Comment thread docs/index.md
Comment thread docs/index.md
@steam-bell-92
Copy link
Copy Markdown
Contributor Author

Addressed Issues:

Fixes #1261

Screenshots/Recordings:

Screenshot 2026-05-10 014818

AI Usage Disclosure:

  • This PR does not contain AI-generated code at all.
  • This PR contains AI-generated code. I have read the AI Usage Policy and this PR complies with this policy. I have tested the code locally and I am responsible for it.

I have used the following AI models and tools: Yes I have used AI tools as finding particular sections was tedious

Checklist

  • My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • My code follows the project's code style and conventions
  • If applicable, I have made corresponding changes or additions to the documentation
  • If applicable, I have made corresponding changes or additions to tests
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contribution Guidelines
  • Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.
  • I have filled this PR template completely and carefully, and I understand that my PR may be closed without review otherwise.

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation navigation by consolidating backend API documentation references into the primary backend links list for improved organization.

Review Change Stack

@steam-bell-92
Copy link
Copy Markdown
Contributor Author

Have made one more commit solving 2nd issue assigned to me

@rohan-pandeyy
Copy link
Copy Markdown
Contributor

@steam-bell-92 thanks for opening the PR!

From the attached screenshots, I noticed that both “Python API” and “Rust API” have been renamed to just “API”. That makes navigation a bit confusing, since it’s no longer clear which backend each page belongs to.

As I mentioned in the issue comment, the hyperlinks should retain the full names similar to the sidebar's:

Backend's rows being:
Python Backend API
Python Backend Database
Python Backend Directory Structure
Python Backend Image Processing
Rust Backend API

These should be used as the hyperlink names for better clarity and in same order consistency.
image

@steam-bell-92
Copy link
Copy Markdown
Contributor Author

@rohan-pandeyy sorry for that confusion I created. That pic was after my 1st commit but in 2nd commit I fixed the naming n order part

Here's preview of markdown after 2nd commit:
image

@rohan-pandeyy rohan-pandeyy merged commit cd211bc into AOSSIE-Org:main May 10, 2026
4 checks passed
@rohan-pandeyy
Copy link
Copy Markdown
Contributor

Thank you for your contribution @steam-bell-92! 😄

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.

Reorganize sidebar structure to match Introduction page hierarchy Fix alphabetical ordering of E* schemas in Python Backend API docs

3 participants