fix: resolve #100 — Add repository architecture map for new contributors#127
Open
andoan16 wants to merge 1 commit into
Conversation
…ew contributors Fixes SahilKumar75#100 Signed-off-by: Ân Đoàn <33853760+andoan16@users.noreply.github.com>
📝 WalkthroughWalkthroughThe README repository overview is restructured from an informal "3 working parts" description to a formal "Repository Architecture" section that documents the purpose and structure of each top-level directory (app/, backend/, ml-worker/, and docs/). ChangesRepository Architecture Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
40-48:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winFix absolute file paths that will break for other users.
Lines 40-48 contain hardcoded absolute paths (e.g.,
/Users/sahilkumarsingh/Desktop/SENTRI/docs/...) that only work on the author's machine. All other contributors will encounter broken links.🔗 Proposed fix using relative paths
-- HLD: [docs/system-design-hld.md](/Users/sahilkumarsingh/Desktop/SENTRI/docs/system-design-hld.md) -- LLD: [docs/system-design-lld.md](/Users/sahilkumarsingh/Desktop/SENTRI/docs/system-design-lld.md) -- Home AI logic: [docs/ai-logic-home-timetable.md](/Users/sahilkumarsingh/Desktop/SENTRI/docs/ai-logic-home-timetable.md) -- Myspace AI logic: [docs/ai-logic-myspace.md](/Users/sahilkumarsingh/Desktop/SENTRI/docs/ai-logic-myspace.md) -- Myspace indexing pipeline: [docs/myspace-indexing-pipeline.md](/Users/sahilkumarsingh/Desktop/SENTRI/docs/myspace-indexing-pipeline.md) -- Contribution workflow: [CONTRIBUTING.md](/Users/sahilkumarsingh/Desktop/SENTRI/CONTRIBUTING.md) -- Code of conduct: [CODE_OF_CONDUCT.md](/Users/sahilkumarsingh/Desktop/SENTRI/CODE_OF_CONDUCT.md) -- Security policy: [SECURITY.md](/Users/sahilkumarsingh/Desktop/SENTRI/SECURITY.md) -- Support policy: [SUPPORT.md](/Users/sahilkumarsingh/Desktop/SENTRI/SUPPORT.md) +- HLD: [docs/system-design-hld.md](docs/system-design-hld.md) +- LLD: [docs/system-design-lld.md](docs/system-design-lld.md) +- Home AI logic: [docs/ai-logic-home-timetable.md](docs/ai-logic-home-timetable.md) +- Myspace AI logic: [docs/ai-logic-myspace.md](docs/ai-logic-myspace.md) +- Myspace indexing pipeline: [docs/myspace-indexing-pipeline.md](docs/myspace-indexing-pipeline.md) +- Contribution workflow: [CONTRIBUTING.md](CONTRIBUTING.md) +- Code of conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) +- Security policy: [SECURITY.md](SECURITY.md) +- Support policy: [SUPPORT.md](SUPPORT.md)🤖 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` around lines 40 - 48, The README contains hardcoded absolute file paths for links (e.g., docs/system-design-hld.md, docs/system-design-lld.md, docs/ai-logic-home-timetable.md, docs/ai-logic-myspace.md, docs/myspace-indexing-pipeline.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, SUPPORT.md) which will break for other users; edit the links in README.md to use relative paths (remove the /Users/... prefix) so they point to the repository files (e.g., ./docs/system-design-hld.md or docs/system-design-hld.md) ensuring all listed references resolve across machines and CI.
🤖 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 `@README.md`:
- Around line 8-13: Update the "Repository Architecture" section in README.md to
add direct links to the existing architecture and contribution docs by appending
a single line after the directory list that points to docs/system-design-hld.md
(HLD), docs/system-design-lld.md (LLD), and CONTRIBUTING.md; ensure the link
text matches the PR suggestion (e.g., "For detailed architecture and
contribution workflow, see [HLD](docs/system-design-hld.md),
[LLD](docs/system-design-lld.md), and [CONTRIBUTING.md](CONTRIBUTING.md)"), so
readers can quickly navigate from the described folders to the full HLD/LLD and
contribution guide.
---
Outside diff comments:
In `@README.md`:
- Around line 40-48: The README contains hardcoded absolute file paths for links
(e.g., docs/system-design-hld.md, docs/system-design-lld.md,
docs/ai-logic-home-timetable.md, docs/ai-logic-myspace.md,
docs/myspace-indexing-pipeline.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md,
SECURITY.md, SUPPORT.md) which will break for other users; edit the links in
README.md to use relative paths (remove the /Users/... prefix) so they point to
the repository files (e.g., ./docs/system-design-hld.md or
docs/system-design-hld.md) ensuring all listed references resolve across
machines and CI.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+8
to
+13
| ## Repository Architecture | ||
|
|
||
| - `app/`: Expo React Native frontend for iPhone and Android | ||
| - `backend/`: Spring Boot API and timetable storage layer | ||
| - `ml-worker/`: Python OCR and timetable normalization worker | ||
| - `docs/`: System design documents and contribution guides |
There was a problem hiding this comment.
Add links to HLD, LLD, and contribution guide.
The PR objectives explicitly require linking to existing architecture documentation. The current section describes directories but doesn't guide contributors to the detailed HLD, LLD, or CONTRIBUTING.md.
Consider adding a brief line after the directory list:
For detailed architecture and contribution workflow, see [HLD](docs/system-design-hld.md), [LLD](docs/system-design-lld.md), and [CONTRIBUTING.md](CONTRIBUTING.md).This keeps the section scannable while fulfilling the requirement to "link to existing documentation rather than duplicate it."
🤖 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` around lines 8 - 13, Update the "Repository Architecture" section
in README.md to add direct links to the existing architecture and contribution
docs by appending a single line after the directory list that points to
docs/system-design-hld.md (HLD), docs/system-design-lld.md (LLD), and
CONTRIBUTING.md; ensure the link text matches the PR suggestion (e.g., "For
detailed architecture and contribution workflow, see
[HLD](docs/system-design-hld.md), [LLD](docs/system-design-lld.md), and
[CONTRIBUTING.md](CONTRIBUTING.md)"), so readers can quickly navigate from the
described folders to the full HLD/LLD and contribution guide.
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
1 participant
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.
Summary
fix: resolve #100 — Add repository architecture map for new contributors
Problem
Severity:
Medium| File:README.mdAdd a concise architecture map to help new contributors understand the project structure and where to make changes for different types of work (app, backend, ML worker, docs). The map should link to existing documentation rather than duplicating content, and be scannable for first-time contributors.
Solution
Add a new section titled "Repository Architecture" after the introduction in README.md. Include a brief description of each main directory (app, backend, ml-worker, docs) with their purposes, and link to the existing HLD, LLD, and contribution guide. Use bullet points or a simple diagram to show how these components interact. Keep the section under 10 lines for easy scanning.
Changes
README.md(modified)Testing
Summary by CodeRabbit