Skip to content

docs: add architecture overview documentation#1143

Open
srinidhi-2006-bit wants to merge 4 commits into
Priyanshu-byte-coder:mainfrom
srinidhi-2006-bit:docs/architecture-overview
Open

docs: add architecture overview documentation#1143
srinidhi-2006-bit wants to merge 4 commits into
Priyanshu-byte-coder:mainfrom
srinidhi-2006-bit:docs/architecture-overview

Conversation

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor

Summary

Added architecture overview documentation with a Mermaid-based system architecture diagram explaining DevTrack’s frontend, API layer, database, and external integrations.

Closes #1038

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor / code cleanup

Changes Made

  • Added docs/architecture.md
  • Added Mermaid system architecture diagram
  • Documented frontend, API, database, and external service flow
  • Added README link to architecture documentation

How to Test

  1. Open docs/architecture.md
  2. Verify the Mermaid diagram renders correctly
  3. Check that all architecture sections display properly
  4. Open README.md
  5. Verify the Architecture Overview documentation link works correctly

Screenshots (if UI change)

N/A

Checklist

  • Linked issue in summary
  • npm run lint passes locally
  • No TypeScript errors (npm run type-check)
  • Self-reviewed the diff
  • Added/updated tests if applicable

@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

@srinidhi-2006-bit is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added gssoc26 GSSoC 2026 contribution type:docs GSSoC type bonus: documentation (+5 pts) type:feature GSSoC type bonus: new feature labels May 26, 2026
@github-actions
Copy link
Copy Markdown

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — please apply the appropriate labels before merging:

Difficulty (pick one):

  • level:beginner — 20 pts
  • level:intermediate — 35 pts
  • level:advanced — 55 pts
  • level:critical — 80 pts

Quality (optional):

  • quality:clean — ×1.2 multiplier
  • quality:exceptional — ×1.5 multiplier

Validation (required to score):

  • gssoc:approved — counts for points
  • gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor Author

Thanks for reviewing the PR.

The failing Playwright smoke test appears unrelated to this documentation-only change, since build, lint, and type-check checks are all passing successfully.

This PR only adds architecture documentation and README references without modifying application logic or E2E-related functionality.

@Priyanshu-byte-coder Priyanshu-byte-coder added level:intermediate GSSoC: Intermediate difficulty (35 pts) gssoc:approved GSSoC: PR approved for scoring labels May 26, 2026
@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

Playwright smoke tests are failing on this PR. Check the CI logs, fix failing tests, then push an update. Cannot merge while tests are red.

@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

Playwright smoke tests are failing on this PR. Please check the E2E test failures and fix them before merging.

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor Author

I investigated the failing Playwright smoke tests locally.

The failures appear unrelated to this documentation-only PR because this PR only adds:

  • architecture documentation
  • Mermaid system diagram
  • README references

No application logic, routing, authentication flow, or E2E-related functionality was modified.

I verified locally that:

  • npm run lint passes
  • npm run type-check passes
  • npm run build passes

The current Playwright failures are caused by existing repo-wide E2E assertions expecting outdated UI/routes/components rather than changes introduced in this PR.

@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

CI is failing on this PR. Please fix the failing checks before this can be merged.

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor Author

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved GSSoC: PR approved for scoring gssoc26 GSSoC 2026 contribution level:intermediate GSSoC: Intermediate difficulty (35 pts) type:docs GSSoC type bonus: documentation (+5 pts) type:feature GSSoC type bonus: new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add architecture overview diagram to wiki

2 participants