DOC: Remove setup instructions from docs website and create unified s…

[Aditya30ag]

Description

This PR addresses issue #438 by removing old setup instructions from the docs website and creating a unified setup instructions page.

Changes Made

🗑️ Removed Files

• docs/Manual_Setup_Guide.md - Old manual setup guide
• docs/Script_Setup_Guide.md - Old script setup guide
• docs/frontend/setup.md - Old frontend setup guide
• docs/backend/backend_python/setup.md - Old Python backend setup guide
• docs/backend/backend_rust/setup.md - Old Rust backend setup guide
• docs/backend/docker-setup.md - Old backend Docker setup guide
• docs/frontend/docker-setup.md - Old frontend Docker setup guide

✅ Created/Updated Files

• Created docs/setup.md - Unified setup instructions page that redirects to README.md
• Updated mkdocs.yml - Removed setup-related navigation entries and added unified setup page
• Updated README.md - Consolidated and enhanced setup instructions with comprehensive details

Benefits

• Single source of truth: All setup instructions are now in the README.md file
• Better maintainability: No need to update multiple files when setup changes
• Improved user experience: Users can find setup instructions immediately in the main repository
• Reduced duplication: Eliminated redundant setup documentation
• Cleaner docs structure: Removed clutter from the documentation website

Testing

• Verified that the new setup.md page properly redirects to README.md
• Confirmed that mkdocs.yml navigation is properly updated
• Validated that README.md contains all necessary setup information
• Checked that all old setup files have been removed

Related Issue

Fixes #438

Type of Change

• Documentation update
• Bug fix (removing outdated documentation)
• Improvement (consolidating setup instructions)

Checklist

• Changes have been tested locally
• Documentation has been updated
• All setup instructions are consolidated in README.md
• Old setup files have been removed
• Navigation has been updated appropriately

Summary by CodeRabbit

• Documentation

  • Consolidated all setup guides into a single, simplified setup page with links to the main README and troubleshooting resources.
  • Removed multiple detailed setup and Docker guides for backend and frontend to reduce redundancy.
  • Updated documentation navigation for easier access to setup instructions.

• Bug Fixes

  • Fixed loading screen rendering in the Albums view for more reliable display.

• Style

  • Improved and standardized styling for album headers and messages in the Albums view.

• Chores

  • Set minimum window size (1280x720) for the desktop application.

[coderabbitai]

Walkthrough

All setup-related documentation files for backend, frontend, and Docker were deleted from the documentation directory. A new unified docs/setup.md was added, redirecting users to the main README.md for setup instructions. The documentation navigation (mkdocs.yml) was updated to remove old setup links and reference the new unified page. Minor unrelated code and configuration changes were also made.

Changes

File(s)	Change Summary
docs/Manual_Setup_Guide.md, docs/Script_Setup_Guide.md, docs/backend/backend_python/setup.md, docs/backend/backend_rust/setup.md, docs/backend/docker-setup.md, docs/frontend/docker-setup.md, docs/frontend/setup.md	Deleted all setup-related documentation files for backend, frontend, and Docker.
docs/setup.md	Added a new unified setup instructions page redirecting to the README.md.
mkdocs.yml	Updated navigation: removed old setup links, added a single top-level "Setup" page.
backend/app/ner/test.py, backend/app/routes/images.py, backend/app/schemas/facetagging.py	Minor formatting and syntactic adjustments; no logic changes.
frontend/src/components/Album/Album.tsx	Fixed missing return in loading state and refactored class names for styling consistency.
frontend/src-tauri/tauri.conf.json	Set minimum window size constraints for the Tauri app.

Sequence Diagram(s)

Not included, as changes are limited to documentation, configuration, and minor code formatting without affecting control flow or introducing new features.

Assessment against linked issues

Objective	Addressed	Explanation
Remove all setup instructions from docs website (#438)	✅
Add a new unified setup instructions page redirecting to README (#438)	✅
Update navigation to remove setup sections and reference new page (#438)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Minor syntactic change in tuple unpacking (backend/app/ner/test.py)	This change is unrelated to documentation objectives; it is a code formatting update.
Formatting of conditional expression (backend/app/routes/images.py)	This is a code formatting change, not related to documentation restructuring.
Added blank line after imports (backend/app/schemas/facetagging.py)	This is a trivial formatting change, not related to the stated documentation objectives.
Styling and return fix in Album.tsx (frontend/src/components/Album/Album.tsx)	This is a frontend UI/UX fix, unrelated to documentation restructuring.
Set min window size in Tauri config (frontend/src-tauri/tauri.conf.json)	This is a configuration change for the app window, not related to documentation objectives.

Poem

🐇
The docs were once a tangled maze,
With setup guides in scattered arrays.
Now one page leads you on your quest,
The README shows the way that's best!
Out with the old, in with the neat—
A rabbit’s work is now complete!
🥕

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9358ff3 and 8cd937c.

📒 Files selected for processing (1)

• frontend/src-tauri/tauri.conf.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• frontend/src-tauri/tauri.conf.json

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Tauri Tests
• GitHub Check: Backend Tests
• GitHub Check: tauri-build-check (ubuntu-22.04)
• GitHub Check: tauri-build-check (macos-latest, --target aarch64-apple-darwin)
• GitHub Check: tauri-build-check (windows-latest)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[rahulharpal1603]

Hi, can you share a small screen recording of the updated docs website to explain the changes?

[Aditya30ag]

Sure !!
just a minute

[Aditya30ag]

Untitled.video.-.Made.with.Clipchamp.mp4

[Aditya30ag]

Untitled.video.-.Made.with.Clipchamp.1.mp4

[Aditya30ag]

✅ All items nested under the "Home" tab - Introduction, Overview, Setup, Backend, and Frontend sections are all accessible through the Home tab
✅ No duplicate sections - Removed all the duplicate entries that were appearing as separate top-level items
✅ Clean structure - Proper indentation and organization
The navigation now shows everything under the "Home" tab as you requested, without any duplicate "Setup" or other sections appearing separately in the navigation bar.

[rahulharpal1603]

Hi @Aditya30ag, Please run npx prettier --write . inside the frontend folder once and push the changes. The linting check must pass.

[rahulharpal1603]

Thank you @Aditya30ag!