Improve README wording and formatting #1045

gohil-gaurav · 2026-01-16T07:06:37Z

This PR improves README clarity and formatting by refining wording and heading consistency.

Summary by CodeRabbit

Documentation

Clarified project architecture with dedicated Frontend and Backend sections.
Added new contributions section with community Discord link.
Enhanced backend technology stack documentation with additional components.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

github-actions · 2026-01-16T07:06:54Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

coderabbitai · 2026-01-16T07:07:00Z

📝 Walkthrough

Walkthrough

README.md has been updated with improved documentation clarity. Changes include reworded frontend/backend descriptions, a new contributions section header, refined Discord link formatting, and restructured architecture details highlighting the FastAPI backend stack with YOLO, FaceNet, ONNX Runtime, and DBSCAN components.

Changes

Cohort / File(s)	Summary
Documentation Update `README.md`	Refined frontend/backend terminology, introduced "Want to Contribute?" section, updated Discord link formatting (simplified text and path notation from "->" to "→"), restructured architecture section with dedicated Frontend subsection, renamed backend label to "Backend (Python - FastAPI)", and expanded backend stack description to include YOLO, FaceNet, ONNX Runtime, and DBSCAN

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Revise docs for setup links and feature details #462: Updates project documentation and technical stack descriptions including YOLO, FaceNet, and database/framework stack details.

Suggested labels

documentation

Poem

🐰 Words rewoven with care and thought,
FastAPI now shines in the light we sought,
YOLO and FaceNet join the band,
A clearer vision, refined and grand—
The README hops forward, understanding in hand! 🎉

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes to the README: improving wording and formatting through rewording descriptions, restructuring sections, and updating link formatting.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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.}

github-actions · 2026-01-16T07:07:56Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

coderabbitai

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@README.md`:
- 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>.
- 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.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a3af96c and b6f5322.

📒 Files selected for processing (1)

README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

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

(MD045, no-alt-text)

🔇 Additional comments (3)

README.md (3)

5-6: Nice improvement to document structure.

Adding a dedicated header for the contribution section makes it more discoverable and welcoming.

10-10: Good formatting improvements.

The cleaner link text and proper arrow notation (→) improve readability and follow better typographic conventions.

21-21: Good clarification.

Adding "FastAPI" to the backend label provides helpful specificity about the framework in use, making it easier for contributors to understand the tech stack.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

coderabbitai · 2026-01-16T07:08:35Z

README.md

 # 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.


⚠️ 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.

coderabbitai · 2026-01-16T07:08:35Z

README.md

+
+## 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>


⚠️ 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

-   <a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a> +   <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

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

   <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>.

Improve README wording and formatting

b6f5322

coderabbitai bot reviewed Jan 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve README wording and formatting #1045

Improve README wording and formatting #1045

Uh oh!

gohil-gaurav commented Jan 16, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Jan 16, 2026

Uh oh!

coderabbitai bot commented Jan 16, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Poem

Uh oh!

github-actions bot commented Jan 16, 2026

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Jan 16, 2026

Uh oh!

coderabbitai bot Jan 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	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.


		## Want to Contribute? 😄

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

Improve README wording and formatting #1045

Are you sure you want to change the base?

Improve README wording and formatting #1045

Uh oh!

Conversation

gohil-gaurav commented Jan 16, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Documentation

Uh oh!

github-actions bot commented Jan 16, 2026

Uh oh!

coderabbitai bot commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Poem

Uh oh!

github-actions bot commented Jan 16, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

gohil-gaurav commented Jan 16, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 16, 2026 •

edited

Loading