Skip to content

Improve README wording and formatting #1045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gohil-gaurav wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −4
Open

Improve README wording and formatting #1045

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# PictoPy

PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management.
PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust on the frontend with a Python backend for sophisticated image analysis and management.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Clarify the frontend/backend architecture description.

The phrase "Tauri, React, and Rust on the frontend" is technically inaccurate. According to your architecture section (lines 15-32), Rust powers the Tauri backend layer, not the frontend. The frontend consists of the Tauri framework and React for UI.

Consider rewording for technical accuracy:

📝 Suggested rewording 
-PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust on the frontend with a Python backend for sophisticated image analysis and management.
+PictoPy is an advanced desktop gallery application built with Tauri and React for the frontend, with dual backends in Rust (Tauri) and Python (FastAPI) for sophisticated image analysis and management.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust on the frontend with a Python backend for sophisticated image analysis and management.
PictoPy is an advanced desktop gallery application built with Tauri and React for the frontend, with dual backends in Rust (Tauri) and Python (FastAPI) for sophisticated image analysis and management.
🤖 Prompt for AI Agents 
In `@README.md` at line 3, Update the inaccurate phrase "Tauri, React, and Rust on
the frontend" in the README: change it to state that the frontend is built with
Tauri and React (React for UI) and that Rust powers the Tauri backend layer;
locate the sentence containing "Tauri, React, and Rust on the frontend" and the
"architecture" section wording and replace with text that clearly separates
frontend (Tauri + React) from the Rust-powered Tauri backend.


# Want to Contribute? 😄

## Want to Contribute? 😄

&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add alt text for accessibility.

The Discord badge image is missing alt text, which prevents screen readers from conveying its purpose to visually impaired users.

♿ Proposed fix for accessibility 
-&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a>
+&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" alt="Join our Discord server" height="40"></a>

Based on static analysis hints.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a>
&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" alt="Join our Discord server" height="40"></a>
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

8-8: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
In `@README.md` at line 8, The Discord badge image tag is missing alt text; update
the <img> element used for the Discord badge in README.md to include a
meaningful alt attribute (e.g., alt="Join our Discord" or similar) so screen
readers can convey its purpose—locate the <a>...<img ...> snippet for the
Discord badge and add an appropriate alt string to the <img>.


1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn)** (Go to Projects → PictoPy) to chat with the community.
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.

# Architecture
Expand All @@ -17,7 +18,7 @@ PictoPy is an advanced desktop gallery application that combines the power of Ta
- **React**: Used for creating the user interface
- **Rust**: Powers the backend, which the frontend communicates with through Tauri's API

### Backend (Python)
### Backend (Python - FastAPI)

- **FastAPI**: Serves as the API framework
- **SQLite**: Database for storing metadata and embeddings
Expand Down