Refactor README structure for improved readability and maintainability#1258
Refactor README structure for improved readability and maintainability#1258rohan-pandeyy wants to merge 1 commit intoAOSSIE-Org:mainfrom
Conversation
WalkthroughThis PR updates multiple documentation files across the project: removes emoji prefixes from CONTRIBUTING.md headings, updates the copyright year to 2026, comprehensively restructures README.md with new feature sections and social badges, and replaces an embedded database schema iframe with a static architecture image in the backend documentation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
7-7: Use a subordinate heading level for “Setting Up the Project.”Line 7 should be
##(not#) so the document has a single H1 and clearer hierarchy.As per coding guidelines, "Confirm that the code meets the project's requirements and objectives."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 7, Change the top-level heading "Setting Up the Project" to a subordinate heading by replacing the single '#' with '##' so the document has only one H1 and a clear hierarchy; locate the line containing the heading text "Setting Up the Project" and update it accordingly, ensuring the rest of the document structure remains unchanged and the heading now uses '##'.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/backend/backend_python/database.md`:
- Line 9: Update the img tag's alt attribute in the documentation (the <img
src="../../assets/database_architecture.svg" .../> element) so the alt text
accurately describes the image content; replace alt="PictoPy Banner" with a
descriptive phrase such as "Database architecture diagram" (or similar) to
reflect that it is a database schema image and fix the spelling/grammar if
necessary.
In `@README.md`:
- Line 114: Replace the placeholder string "TODO" in the contributor thank-you
sentence that currently reads "helping TODO grow" with the actual project name
(or a neutral phrase like "this project") so the user-facing README text is not
left as an unfinished placeholder; locate the exact occurrence of "helping TODO
grow" in README.md and update it to "helping <project-name> grow" or "helping
this project grow" and search for any other "TODO" placeholders in the same file
to correct them similarly.
- Line 97: The Discord badge <img> element in README.md is missing an alt
attribute; update the <img
src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287"
height="30"> tag to include a concise alt text (e.g., alt="Discord server") to
satisfy markdownlint MD045 and accessibility guidelines.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 7: Change the top-level heading "Setting Up the Project" to a subordinate
heading by replacing the single '#' with '##' so the document has only one H1
and a clear hierarchy; locate the line containing the heading text "Setting Up
the Project" and update it accordingly, ensuring the rest of the document
structure remains unchanged and the heading now uses '##'.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 15ead3f4-a14f-4de2-ad8f-d934f44b36b6
⛔ Files ignored due to path filters (5)
docs/assets/architectual-design-dark.svgis excluded by!**/*.svgdocs/assets/architectual-design-light.svgis excluded by!**/*.svgdocs/assets/banner.pngis excluded by!**/*.pngdocs/assets/database_architecture.svgis excluded by!**/*.svgdocs/assets/demo.pngis excluded by!**/*.png
📒 Files selected for processing (4)
CONTRIBUTING.mdCOPYRIGHT.mdREADME.mddocs/backend/backend_python/database.md
|
|
||
| ## Database Schema | ||
| <p align="center"> | ||
| <img src="../../assets/database_architecture.svg" alt="PictoPy Banner" width="100%"/> |
There was a problem hiding this comment.
Update image alt text to match the actual content.
Line 9 uses alt="PictoPy Banner", but this is a database schema image. Please use a descriptive alt text like Database architecture diagram.
As per coding guidelines, "Verify that documentation and comments are free of spelling mistakes."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/backend/backend_python/database.md` at line 9, Update the img tag's alt
attribute in the documentation (the <img
src="../../assets/database_architecture.svg" .../> element) so the alt text
accurately describes the image content; replace alt="PictoPy Banner" with a
descriptive phrase such as "Database architecture diagram" (or similar) to
reflect that it is a database schema image and fix the spelling/grammar if
necessary.
|
|
||
| ## Want to Contribute? | ||
|
|
||
| <a href="https://discord.gg/hjUhu33uAn"><img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" height="30"></a> |
There was a problem hiding this comment.
Add alt text to the Discord badge image.
Line 97’s <img> is missing an alt attribute (also flagged by markdownlint MD045).
As per coding guidelines, "Confirm that the code meets the project's requirements and objectives."
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 97-97: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 97, The Discord badge <img> element in README.md is
missing an alt attribute; update the <img
src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287"
height="30"> tag to include a concise alt text (e.g., alt="Discord server") to
satisfy markdownlint MD045 and accessibility guidelines.
|
|
||
| ## Thanks To All Contributors | ||
|
|
||
| Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂 |
There was a problem hiding this comment.
Replace the placeholder “TODO” in contributor thanks text.
Line 114 currently says “helping TODO grow,” which reads like an unfinished placeholder in user-facing docs.
As per coding guidelines, "Suggest code completions when seeing a TODO or FIXME comment."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 114, Replace the placeholder string "TODO" in the
contributor thank-you sentence that currently reads "helping TODO grow" with the
actual project name (or a neutral phrase like "this project") so the user-facing
README text is not left as an unfinished placeholder; locate the exact
occurrence of "helping TODO grow" in README.md and update it to "helping
<project-name> grow" or "helping this project grow" and search for any other
"TODO" placeholders in the same file to correct them similarly.
1 participant
Addressed Issues:
Fixes #1257
This pull request improves the documentation and project presentation for PictoPy, focusing on enhancing the README with a clearer project overview, updated social links, and a new architecture diagram. It also updates copyright information and streamlines the contributing and database documentation.
README and Documentation Enhancements:
README.mdto provide a more compelling project description, add social media badges, highlight key features, and include a demonstration section with images and video links. The technical stack section is reorganized, and a new high-level architecture diagram is added for better clarity. Contribution instructions and licensing information are now more prominent. [1] [2]docs/backend/backend_python/database.md) to replace the embedded interactive schema with a static image and a link to the interactive diagram, improving accessibility and presentation.Legal and Contributing Updates:
COPYRIGHT.mdfrom 2025 to 2026.CONTRIBUTING.mdfor consistency with the rest of the documentation.Screenshots/Recordings:
Additional Notes:
AI Usage Disclosure:
We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact. AI slop is strongly discouraged and may lead to banning and blocking. Do not spam our repos with AI slop.
Check one of the checkboxes below:
I have used the following AI models and tools: TODO
Checklist
Summary by CodeRabbit