From b43d34f707497eb7d89c3b0f17e4c932caacd66e Mon Sep 17 00:00:00 2001
From: ROHAN PANDEY <95585299+rohan-pandeyy@users.noreply.github.com>
Date: Sat, 12 Jul 2025 23:41:41 +0530
Subject: [PATCH 1/2] Revise docs for setup links and feature details

Updated documentation to reference CONTRIBUTING.md for setup instructions instead of README.md. Improved features overview for clarity and updated technical stack details. Fixed and standardized links to Docker setup pages in index.md.
---
 docs/index.md             | 21 ++++-----------------
 docs/overview/features.md | 37 +++++++++++++++++++++++++++++--------
 docs/setup.md             |  6 +++---
 3 files changed, 36 insertions(+), 28 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index f54596d20..bdb832acd 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -26,11 +26,6 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
     <div style="width:25%">
         <h2>Backend Python</h2>
         <ul>
-            <li>
-                <a href="./backend/backend_python/setup">
-                    Setup
-                </a>
-            </li>
             <li>
                 <a href="./backend/backend_python/database">
                     Database
@@ -56,18 +51,15 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
     <div style="width:25%">
         <h2>Backend Rust</h2>
         <ul>
-            <li>
-                <a href="./backend/backend_rust/setup">
-                    Setup
-                </a>
-            </li>
             <li>
                 <a href="./backend/backend_rust/api">
                     API
                 </a>
             </li>
             <li>
-              <a href="./backend/docker-setup.md">Docker setup</a>
+                <a href="./backend/docker-setup">
+                    Docker setup
+                </a>
             </li>
         </ul>
     </div>
@@ -75,12 +67,7 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
         <h2>Frontend</h2>
         <ul>
             <li>
-                <a href="./frontend/setup">
-                    Setup
-                </a>
-            </li>
-            <li>
-               <a href="./frontend/docker-setup.md">
+               <a href="./frontend/docker-setup">
                     Docker Setup
                 </a>
             </li>
diff --git a/docs/overview/features.md b/docs/overview/features.md
index 7d65d486d..bdafdd1de 100644
--- a/docs/overview/features.md
+++ b/docs/overview/features.md
@@ -1,16 +1,37 @@
 # PictoPy Features
 
-!!! note "Gallery Applicaiton" - Smart tagging of photos based on detected objects, faces and their recognition - Traditional gallery features of album management.
+### Gallery Application
 
-!!! tip "Advanced Image Analysis" - Object detection using YOLOv8, enabling identification of various items in photos - Facial recognition powered by FaceNet, allowing for face detection and clustering
+- **Intelligent Photo Tagging**: Automatically tags photos based on detected objects, faces, and facial recognition.
+- **Traditional Gallery Management**: Complete album organization and management tools.
 
-!!! success "Privacy-Focused Design" - Offline functionality ensuring user data remains on the local machine - No reliance on remote servers for image processing or analysis - Models are stored locally and can be changed according to user needs
+### Advanced Image Analysis
 
-!!! abstract "Data Handling and Parallel Processing" - Utilizes SQLite databases for lightweight and efficient storage of photo metadata, face embeddings, and album information - Implements background processing for handling large volumes of images without impacting user experience - Uses `asyncio` in the back to process images without blocking the frontend
+- Object detection using **YOLOv8** for identifying various items in images
+- Face detection and clustering powered by **FaceNet**.
 
-!!! example "Smart Search and Retrieval" - Enables searching for photos based on detected objects, faces, or other metadata - Supports finding related images based on facial similarity or content
+### Privacy-Focused Design
 
-!!! info "Cross-Platform Compatibility" - Designed to work across different operating systems
+- **Entirely offline**: All data stays on your local machine.
+- No reliance on remote servers for processing.
+- Models are stored locally and customizable by the user.
+
+### Efficient Data Handling & Processing
+
+- Lightweight **SQLite** database for storing image metadata, face embeddings, and album info.
+- Background image processing using `asyncio` for a smooth UI experience.
+
+### Smart Search & Retrieval
+
+- Search photos based on:
+  - Detected objects
+  - Recognized faces
+  - Embedded metadata
+- Find visually or semantically similar images
+
+### Cross-Platform Compatibility
+
+- Available on major operating systems (Windows, macOS, Linux)
 
 ## Technical Stack
 
@@ -25,9 +46,9 @@
 | Object Detection  | YOLOv8               |
 | Face Recognition  | FaceNet              |
 | API Framework     | FastAPI              |
-| State Management  | React Hooks          |
+| State Management  | Redux Toolkit        |
 | Styling           | Tailwind CSS         |
 | Routing           | React Router         |
-| UI Components     | Radix UI             |
+| UI Components     | ShadCN               |
 | Build Tool        | Vite                 |
 | Type Checking     | TypeScript           |
diff --git a/docs/setup.md b/docs/setup.md
index 6eecee4b0..542445033 100644
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -1,6 +1,6 @@
 # Setup Instructions
 
-**Please refer to the [README.md](https://github.com/AOSSIE-Org/PictoPy/blob/main/README.md#setup) file for complete setup instructions.**
+**Please refer to the [CONTRIBUTING.md](https://github.com/AOSSIE-Org/PictoPy/blob/main/CONTRIBUTING.md) file for complete setup instructions.**
 
 ## Available Setup Methods
 
@@ -13,5 +13,5 @@ The README.md file contains detailed instructions for:
 ## Quick Links
 
 - [Main Repository](https://github.com/AOSSIE-Org/PictoPy)
-- [Setup Section in README](https://github.com/AOSSIE-Org/PictoPy/blob/main/README.md#setup)
-- [Troubleshooting](https://github.com/AOSSIE-Org/PictoPy/blob/main/README.md#troubleshooting)
+- [Setup Section in CONTRIBUTING.md](https://github.com/AOSSIE-Org/PictoPy/blob/main/CONTRIBUTING.md#setup)
+- [Troubleshooting](https://github.com/AOSSIE-Org/PictoPy/blob/main/CONTRIBUTING.md#troubleshooting)

From d4802babd1f0ce032e2e7c960a559071ba1b7128 Mon Sep 17 00:00:00 2001
From: Rahul Harpal <51887323+rahulharpal1603@users.noreply.github.com>
Date: Sun, 13 Jul 2025 15:16:24 +0530
Subject: [PATCH 2/2] Update index.md

---
 docs/index.md | 10 ----------
 1 file changed, 10 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index bdb832acd..b3e000633 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -56,21 +56,11 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
                     API
                 </a>
             </li>
-            <li>
-                <a href="./backend/docker-setup">
-                    Docker setup
-                </a>
-            </li>
         </ul>
     </div>
     <div style="width:25%">
         <h2>Frontend</h2>
         <ul>
-            <li>
-               <a href="./frontend/docker-setup">
-                    Docker Setup
-                </a>
-            </li>
             <li>
                 <a href="./frontend/ui-components">
                     UI Components