Scholiphi — Internal Documentation
Scholiphi is an educational platform for schools. It runs on five surfaces:
- Admin Panel — used by school admins and super admins to set up schools, add users, manage transport, plans, and moderation.
- Teacher App — used by teachers to mark attendance, assign work, run live classes, manage doubts, plan lessons.
- Student App — used by students to study, practice, attend classes, ask doubts, take tests.
- Parent App — used by parents to track child performance, view diary, message teachers, attend PTMs.
- Backend — Express + Drizzle/Postgres + Redis + BullMQ powering everything.
What this site is for
This is internal documentation for devs, testers, and the internal team. It is not user help.
The goal is to make it easy to:
- Understand a feature end-to-end without reading code — who triggers it, which apps see it, what state transitions happen, what notifications fire.
- Find the testable surface of any feature — the "edge cases & things to test" section on every page is the QA anchor.
- Onboard new team members quickly to the breadth of the platform.
How the docs are organized
| Section | What's in it |
|---|---|
| Getting Started | Architecture diagram, roles & permissions matrix |
| Admin Panel | One page per admin-only feature (school creation, sub-admins, transport, etc.) |
| Feature Flows | One page per cross-app feature lifecycle (homework, attendance, doubts, AI tutor…) — these are the meatiest pages |
| App Guides | Per-app navigation, auth flow, dashboard, profile — the leftovers |
When a feature touches multiple apps (e.g. Homework — teacher creates → student does → parent sees), it lives under Feature Flows, not under any single app.
Editing these docs
Every page has an "Edit this page" link in the bottom-right that drops you onto the file in the scholiphi GitHub repo. Edits to docs/** on the dev branch redeploy this site automatically.