docs(onboarding): add ONBOARDING-Mohammed-Irfan.md (audit #36-44, closes #341, #342) - #409
Open
MdIrfan325 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a contributor onboarding document under Ideas/ describing FLN, summarizing the current repo architecture, listing observed gaps, and documenting an audit of issues/PRs #36–#44 (referencing #341/#342).
Changes:
- Introduces
Ideas/ONBOARDING-Mohammed-Irfan.mdwith onboarding context, workflow understanding, and an issues/PR audit table. - Documents perceived codebase gaps and proposes follow-up intern-task scoping.
Suppressed comments (4)
Ideas/ONBOARDING-Mohammed-Irfan.md:57
- This line references a legacy browser-side
localStoragemock interceptor, but the current frontend codebase calls the real backend viaapiFetch()(frontend/src/services/apiClient.ts) and does not have a mock interceptor implementation under frontend/src.
6. **Codebase Modularization**: Ongoing migration away from the legacy browser-side `localStorage` mock interceptor towards clean, modular Express controller routes and real MongoDB aggregation pipelines.
Ideas/ONBOARDING-Mohammed-Irfan.md:66
- The file path in this gap citation is incorrect:
frontend/src/views/RoleDashboards.tsxdoes not exist in this repo; the file is located atfrontend/src/components/RoleDashboards.tsx.
| 2 | `frontend/src/views/RoleDashboards.tsx` | Legacy god-file contains thousands of lines of monolithic dashboard code, with remaining dashboard components requiring separation. | Decreases maintainability, causes merge conflicts, and slows down component testing. |
Ideas/ONBOARDING-Mohammed-Irfan.md:69
backend/src/generators/is referenced here, but that directory does not exist in the current backend. Consider pointing at the actual generator entry points (e.g.backend/src/levelGenerator.ts) or removing the directory reference.
| 5 | `backend/src/generators/` | Multiple question generators lack deterministic exclusion filters against repeated identical questions in a single assessment paper. | Risk of duplicate question generation on personalized student assessment sheets. |
Ideas/ONBOARDING-Mohammed-Irfan.md:101
- The #36 audit row claims the current codebase has Mongoose-based student schemas,
/api/v2/students, andRegisterStudentView/BulkUploadView, but those are not present. The backend student APIs are under/api/students(including/api/students/bulk-import), and there are noRegisterStudentView/BulkUploadViewcomponents infrontend/src.
| **#36** | `feat: student registration, management, and bulk upload with role-based access` | `yvarsha-crypto` | Closed (Unmerged) | **Verified Implemented**: Student Mongoose schemas, role-scoped routes (`/api/v2/students`), bulk XLSX parsing, and frontend views (`RegisterStudentView`, `BulkUploadView`) are fully functional in current `backend/` and `frontend/`. | **Closed / Settled**: Superseded by subsequent merged student modules. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+46
to
+49
| The repository is structured as an **npm-workspaces monorepo** consisting of: | ||
| - **`frontend/`**: React 18 single-page application built with TypeScript, Tailwind CSS, Lucide icons, and Vite. | ||
| - **`backend/`**: Node.js and Express.js REST API with MongoDB (Mongoose) persistence and role-based JWT authentication. | ||
| - **`ai-services/`**: Python pipeline for TrOCR character recognition, OpenCV perspective correction, and LLM-assisted diagnostic evaluation. |
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
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
Adds ONBOARDING-Mohammed-Irfan.md in Ideas/ per the contributor onboarding requirement.
Sections Covered: