Revise docs for setup links and feature details #462
Conversation
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.
WalkthroughThis update restructures and clarifies the documentation for PictoPy. It removes certain "Setup" links from the index, updates Docker setup URLs, reformats and expands the features overview, and redirects setup instructions from README.md to CONTRIBUTING.md throughout the documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs Index
participant Features Page
participant Setup Page
User->>Docs Index: Access documentation index
Docs Index-->>User: Show sections (without "Setup" links)
User->>Features Page: View features overview
Features Page-->>User: Display reorganized and detailed features
User->>Setup Page: Seek setup instructions
Setup Page-->>User: Redirect to CONTRIBUTING.md for setup/troubleshooting
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes detected. Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/setup.md (1)
7-12: README reference is now stale – point to CONTRIBUTING insteadThe bullet-point intro still says “The README.md file contains detailed instructions…”, which contradicts the new top-level note that setup docs live in CONTRIBUTING.md.
-The README.md file contains detailed instructions for: +The CONTRIBUTING.md file contains detailed instructions for:
🧹 Nitpick comments (2)
docs/index.md (1)
70-72: Inconsistent capitalisation: “Docker setup” vs “Docker Setup”The Rust section uses “Docker setup”, while the Frontend section says “Docker Setup”.
Pick one style (sentence-case vs title-case) for uniformity.docs/overview/features.md (1)
26-31: Indent sub-bullets for consistencyThe “Search photos based on:” list mixes first-level dashes with an indented sub-list but omits a blank line, which some renderers require for correct nesting. Consider:
- Search photos based on: - Detected objects - Recognized faces - Embedded metadata
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/index.md(1 hunks)docs/overview/features.md(2 hunks)docs/setup.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/overview/features.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Tauri Tests
🔇 Additional comments (2)
docs/setup.md (1)
15-17: Verified: Anchor for “#setup” exists in CONTRIBUTING.md
The grep output shows## Setupat line 7, matching the#setupfragment. The quick-link will work as intended.docs/index.md (1)
60-62: Possible broken path after trimming “.md”The new link
./backend/docker-setupskips thebackend_rustsub-folder that the old file lived in (backend/backend_rust/docker-setup.md).
Unless the file was moved accordingly, this will 404.Please check the final path or adjust to:
<a href="./backend/backend_rust/docker-setup">
rahulharpal1603
added
documentation
|
@rohan-pandeyy please link this PR to its issue. |
|
@rahulharpal1603 So sorry. Slipped out of my mind. Done now :) |
|
Thank you @rohan-pandeyy ! |
My pleasure Rahul! Glad I could contribute. |
2 participants
Fixes #461
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.
Changes:
Summary by CodeRabbit
Summary by CodeRabbit