Fix markdown linting issues and add CI check#1266
Merged
rohan-pandeyy merged 5 commits intoMay 14, 2026
Merged
Conversation
github-actions
Bot
added
CI/CD
documentation
Contributor
WalkthroughAdds a Markdown lint step to CI, introduces a markdownlint-cli2 config, and applies formatting and structural edits across many documentation files (autolinks, fenced blocks, heading fixes, image/markup adjustments, and expanded Memories docs). ChangesDocumentation Restructuring and Markdown Linting
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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}
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/overview/architecture.md (1)
23-28:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix spelling errors in the architecture description.
Several spelling mistakes violate the coding guidelines:
- "techstack" should be "tech stack" (two words)
- "dependancies" should be "dependencies"
- "light weight" should be "lightweight" (one word when used as an adjective)
📝 Proposed spelling fixes
<br> -For the backend, we rely on several techstack, our database is served on sqlite while we using parallel processing capabilities of asyncio due to its compatibility +For the backend, we rely on several tech stacks, our database is served on sqlite while we using parallel processing capabilities of asyncio due to its compatibility with FastAPI. Our models are from various sources, we use YOLO models for object and face detection while we use FaceNet for generating the embeddings -of the faces detected. All these models are run on ONNX runtime to avoid heavy dependancies, keeping the application light weight. +of the faces detected. All these models are run on ONNX runtime to avoid heavy dependencies, keeping the application lightweight.As per coding guidelines: "Verify that documentation and comments are free of spelling mistakes."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/overview/architecture.md` around lines 23 - 28, Replace the misspelled terms in the architecture description: change "techstack" to "tech stack", "dependancies" to "dependencies", and "light weight" to "lightweight"; update the sentences containing these phrases in the architecture description block so grammar remains correct (e.g., "our tech stack", "avoid heavy dependencies", "keeping the application lightweight") and ensure spacing/punctuation around the edited words is consistent.docs/backend/backend_rust/api.md (1)
13-20:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix variable name inconsistency in the code example.
Line 18 stores the result in
resourcesFolderPath, but line 19 logsserverPathwhich is undefined.🐛 Proposed fix
// Example: Get server path const resourcesFolderPath = await invoke("get_resources_folder_path"); -console.log("Resources folder path:", serverPath); +console.log("Resources folder path:", resourcesFolderPath);🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/backend/backend_rust/api.md` around lines 13 - 20, The example has a variable name mismatch: the result of invoke("get_resources_folder_path") is stored in resourcesFolderPath but the console.log uses serverPath (undefined); update the log to use resourcesFolderPath (or rename the variable consistently) so the invoke call, resourcesFolderPath variable, and the console.log all refer to the same identifier (referencing invoke and the get_resources_folder_path call).README.md (1)
117-117:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix copy-paste error: "TODO" should be "PictoPy".
The text currently says "Thanks a lot for spending your time helping TODO grow" but should reference the actual project name "PictoPy" instead.
✏️ Proposed fix
-Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂 +Thanks a lot for spending your time helping PictoPy grow. Keep rocking 🥂🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 117, Replace the incorrect project name in the README text: change the sentence that currently reads "Thanks a lot for spending your time helping TODO grow" to use the real project name "PictoPy" instead (i.e., "Thanks a lot for spending your time helping PictoPy grow"); locate the string "helping TODO grow" in README.md and update it to "helping PictoPy grow".
🧹 Nitpick comments (2)
docs/frontend/memories.md (1)
317-321: ⚡ Quick winClarify working directory for test command.
The test location states
backend/tests/but the command ispytest tests/. Consider specifying the working directory or updating the command to be clearer.For example:
Located in `backend/tests/`: - 100 unit tests covering all routes - Run with: `pytest backend/tests/` (from project root) or `pytest tests/` (from backend directory)This will help prevent confusion for contributors running the tests.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/frontend/memories.md` around lines 317 - 321, Update the test command in the "Located in `backend/tests/`" section to remove ambiguity: either change the command to `pytest backend/tests/` to be run from the project root, or add a clarifying note that `pytest tests/` must be run from the `backend` directory; specifically edit the text that currently reads "Run with: `pytest tests/`" to include both options or a working-directory note so readers know where to run the command relative to the project root.docs/index.md (1)
1-1: 💤 Low valueConsider scoped MD033 suppressions for consistency.
This file disables MD033 for the entire document, while other files in the PR (e.g.,
docs/backend/backend_python/database.md) use the disable/enable pattern to scope suppressions to specific HTML blocks.For consistency and to maintain linting coverage where possible, consider wrapping individual HTML sections with
<!-- markdownlint-disable MD033 -->and<!-- markdownlint-enable MD033 -->pairs.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/index.md` at line 1, Replace the file-level suppression <!-- markdownlint-disable MD033 --> in docs/index.md with scoped disable/enable pairs around only the HTML blocks that need it: remove the top-level directive and wrap each raw-HTML section with <!-- markdownlint-disable MD033 --> ... <!-- markdownlint-enable MD033 --> (matching the pattern used in docs/backend/backend_python/database.md) so linting remains active for the rest of the document.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/backend/backend_rust/api.md`:
- Around line 13-20: The example has a variable name mismatch: the result of
invoke("get_resources_folder_path") is stored in resourcesFolderPath but the
console.log uses serverPath (undefined); update the log to use
resourcesFolderPath (or rename the variable consistently) so the invoke call,
resourcesFolderPath variable, and the console.log all refer to the same
identifier (referencing invoke and the get_resources_folder_path call).
In `@docs/overview/architecture.md`:
- Around line 23-28: Replace the misspelled terms in the architecture
description: change "techstack" to "tech stack", "dependancies" to
"dependencies", and "light weight" to "lightweight"; update the sentences
containing these phrases in the architecture description block so grammar
remains correct (e.g., "our tech stack", "avoid heavy dependencies", "keeping
the application lightweight") and ensure spacing/punctuation around the edited
words is consistent.
In `@README.md`:
- Line 117: Replace the incorrect project name in the README text: change the
sentence that currently reads "Thanks a lot for spending your time helping TODO
grow" to use the real project name "PictoPy" instead (i.e., "Thanks a lot for
spending your time helping PictoPy grow"); locate the string "helping TODO grow"
in README.md and update it to "helping PictoPy grow".
---
Nitpick comments:
In `@docs/frontend/memories.md`:
- Around line 317-321: Update the test command in the "Located in
`backend/tests/`" section to remove ambiguity: either change the command to
`pytest backend/tests/` to be run from the project root, or add a clarifying
note that `pytest tests/` must be run from the `backend` directory; specifically
edit the text that currently reads "Run with: `pytest tests/`" to include both
options or a working-directory note so readers know where to run the command
relative to the project root.
In `@docs/index.md`:
- Line 1: Replace the file-level suppression <!-- markdownlint-disable MD033 -->
in docs/index.md with scoped disable/enable pairs around only the HTML blocks
that need it: remove the top-level directive and wrap each raw-HTML section with
<!-- markdownlint-disable MD033 --> ... <!-- markdownlint-enable MD033 -->
(matching the pattern used in docs/backend/backend_python/database.md) so
linting remains active for the rest of the document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 2c830486-6348-416c-af37-dd4b42e2e7e1
⛔ Files ignored due to path filters (2)
backend/dist/README.mdis excluded by!**/dist/**,!**/dist/**sync-microservice/dist/README.mdis excluded by!**/dist/**,!**/dist/**
📒 Files selected for processing (17)
.github/workflows/pr-check-tests.yml.markdownlint-cli2.jsoncCODE_OF_CONDUCT.mdCONTRIBUTING.mdCOPYRIGHT.mdREADME.mddocs/Manual_Setup_Guide.mddocs/Script_Setup_Guide.mddocs/backend/backend_python/api.mddocs/backend/backend_python/database.mddocs/backend/backend_rust/api.mddocs/frontend/memories.mddocs/frontend/screenshots.mddocs/index.mddocs/overview/architecture.mddocs/overview/features.mdsync-microservice/README.md
💤 Files with no reviewable changes (1)
- docs/frontend/screenshots.md
Contributor
|
Please resolve the merge conflicts before review. Your PR will only be reviewed by a maintainer after all conflicts have been resolved. 📺 Watch this video to understand why conflicts occur and how to resolve them: |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/Script_Setup_Guide.md (1)
19-19:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix command wording mismatch (“globally” vs environment-specific pip install).
Line 98 says packages should be installed globally, but
pip install ...on Line 101 installs into whichever environment is active. This can mislead contributors and break pre-commit setup expectations.Suggested edit
- Before running the `git commit` command, ensure you have the following Python packages installed globally: + Before running `git commit`, ensure these Python packages are installed in your active Python environment (or use `--user` for a user-level install): ```bash - pip install ruff black mypy pre-commit + python -m pip install ruff black mypy pre-commit ```As per coding guidelines, "Confirm that the code meets the project's requirements and objectives".
Also applies to: 98-102
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/Script_Setup_Guide.md` at line 19, The doc currently instructs installing packages "globally" but then shows a bare pip command (pip install ruff black mypy pre-commit) which installs into the active Python environment; update the wording and command so they match: either remove "globally" and explain that the command installs into the current environment, or change the command to use an explicit installer (python -m pip install ruff black mypy pre-commit) to ensure a global/system interpreter install; adjust the sentence around the install step and the shown command so contributors understand whether a global or environment-specific install is intended and that pre-commit requires the correct environment.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/Script_Setup_Guide.md`:
- Line 8: Update the wording of the note on Line 8 (the "Note that Step No.
8..." sentence) to a clearer, grammatically correct sentence; replace it with
something like "Step 8 is not shown in the video; please follow it as well." and
ensure there are no spelling mistakes.
---
Outside diff comments:
In `@docs/Script_Setup_Guide.md`:
- Line 19: The doc currently instructs installing packages "globally" but then
shows a bare pip command (pip install ruff black mypy pre-commit) which installs
into the active Python environment; update the wording and command so they
match: either remove "globally" and explain that the command installs into the
current environment, or change the command to use an explicit installer (python
-m pip install ruff black mypy pre-commit) to ensure a global/system interpreter
install; adjust the sentence around the install step and the shown command so
contributors understand whether a global or environment-specific install is
intended and that pre-commit requires the correct environment.
🪄 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: 671bd2dc-03d2-4651-b5a1-9a03a61969f4
📒 Files selected for processing (2)
docs/Manual_Setup_Guide.mddocs/Script_Setup_Guide.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/Manual_Setup_Guide.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/Manual_Setup_Guide.md`:
- Line 7: Update the product/terminal name casing: replace occurrences of
"MacOS" with "macOS" and "Powershell" with "PowerShell" (e.g., the heading text
"### 2. Open your Terminal (Linux/MacOS) or Powershell (Windows)" and the other
instances at the two other occurrences) so the documentation uses correct
platform/tool names; ensure all three occurrences are updated consistently.
- Line 104: Replace the phrase "test mode" with "development mode" in the
sentence describing the `fastapi dev` command so it reads that the server will
automatically restart in development mode when errors are detected or source
files change; update the sentence containing "The server will start on
`http://localhost:52123` by default. In test mode," to use "development mode"
and keep the rest of the description intact (reference the `fastapi dev` mention
and the URL `http://localhost:52123` to locate the sentence).
🪄 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: d534f3f0-6fe4-4ce9-8ad4-4d3fa02ba9cc
📒 Files selected for processing (2)
docs/Manual_Setup_Guide.mddocs/Script_Setup_Guide.md
✅ Files skipped from review due to trivial changes (1)
- docs/Script_Setup_Guide.md
| ### 1. Fork the PictoPy repository: <https://github.com/AOSSIE-Org/PictoPy> | ||
|
|
||
| #### 2. Open your Terminal (Linux/MacOS) or Powershell (Windows) | ||
| ### 2. Open your Terminal (Linux/MacOS) or Powershell (Windows) |
Contributor
There was a problem hiding this comment.
Fix product/terminal name casing in setup instructions.
Line 7 uses MacOS and Powershell; Line 70 and Line 110 also use Powershell. Please change to macOS and PowerShell for correct platform/tool naming.
Suggested edit
-### 2. Open your Terminal (Linux/MacOS) or Powershell (Windows)
+### 2. Open your Terminal (Linux/macOS) or PowerShell (Windows)
-> **Note:** For backend setup, make sure that you have **Miniconda installed**. See the Prerequisites section above. Additionally, for Windows, make sure that you are using Powershell for the setup, not Command Prompt.
+> **Note:** For backend setup, make sure that you have **Miniconda installed**. See the Prerequisites section above. Additionally, for Windows, make sure that you are using PowerShell for the setup, not Command Prompt.
-> **Note:** For sync-microservice setup, make sure that you have **Miniconda installed**. See the Prerequisites section above. Additionally, for Windows, make sure that you are using Powershell for the setup, not Command Prompt.
+> **Note:** For sync-microservice setup, make sure that you have **Miniconda installed**. See the Prerequisites section above. Additionally, for Windows, make sure that you are using PowerShell for the setup, not Command Prompt.As per coding guidelines, "Verify that documentation and comments are free of spelling mistakes".
Also applies to: 70-70, 110-110
🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: The operating system from Apple is written “macOS”.
Context: ...toPy> ### 2. Open your Terminal (Linux/MacOS) or Powershell (Windows) ### 3. Clone ...
(MAC_OS)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/Manual_Setup_Guide.md` at line 7, Update the product/terminal name
casing: replace occurrences of "MacOS" with "macOS" and "Powershell" with
"PowerShell" (e.g., the heading text "### 2. Open your Terminal (Linux/MacOS) or
Powershell (Windows)" and the other instances at the two other occurrences) so
the documentation uses correct platform/tool names; ensure all three occurrences
are updated consistently.
| fastapi dev --port 52123 | ||
| ``` | ||
|
|
||
| The server will start on `http://localhost:52123` by default. In test mode, the server will automatically restart if any errors are detected or if source files are modified. |
Contributor
There was a problem hiding this comment.
Replace “test mode” with “development mode” for fastapi dev.
Line 104 says “In test mode,” but the command is fastapi dev; this is likely a wording mismatch and can confuse setup expectations.
Suggested edit
- The server will start on `http://localhost:52123` by default. In test mode, the server will automatically restart if any errors are detected or if source files are modified.
+ The server will start on `http://localhost:52123` by default. In development mode, the server will automatically restart if source files are modified.📝 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
| The server will start on `http://localhost:52123` by default. In test mode, the server will automatically restart if any errors are detected or if source files are modified. | |
| The server will start on `http://localhost:52123` by default. In development mode, the server will automatically restart if source files are modified. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/Manual_Setup_Guide.md` at line 104, Replace the phrase "test mode" with
"development mode" in the sentence describing the `fastapi dev` command so it
reads that the server will automatically restart in development mode when errors
are detected or source files change; update the sentence containing "The server
will start on `http://localhost:52123` by default. In test mode," to use
"development mode" and keep the rest of the description intact (reference the
`fastapi dev` mention and the URL `http://localhost:52123` to locate the
sentence).
rohan-pandeyy
approved these changes
May 14, 2026
Contributor
|
Thank you for your contribution @VanshajPoonia! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addressed Issues:
Fixes #1265
Screenshots/Recordings:
Additional Notes:
This PR fixes existing markdownlint issues across the repository and adds Markdown linting to the existing PR Check workflow.
A minimal
.markdownlint-cli2.jsoncconfiguration has been added to keep Markdown linting consistent across the project.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: Claude and Gemini were used for assistance with Markdown linting suggestions, and review. All changes were reviewed manually and validated locally.
Checklist
Summary by CodeRabbit
Documentation
Chores