Skip to content

fix: resolve #100 — Add repository architecture map for new contributors #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andoan16 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: resolve #100 — Add repository architecture map for new contributors #127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ Sentri is a zero-budget cross-platform student companion for Army Institute of T
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](CONTRIBUTING.md)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

This repository is currently split into 3 working parts:
## 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
Comment on lines +8 to +13
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

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.


## Product Scope

Expand Down