How Academia Works
The documentation should follow the real frontend and backend flow.
The best product docs do not describe an abstract system. They explain how tenants, roles, workflows, and interfaces move together from first setup through final defense.
01
Set up tenant-aware academic operations
Departments, campuses, and institutions enter through a tenant-aware frontend backed by authentication, RBAC, and isolated API context.
- Frontend middleware forwards tenant context for dashboard routing
- Backend tenant modules and guards enforce data isolation
- Role-aware onboarding supports department heads, coordinators, advisors, students, and evaluators
02
Run project work from proposal to milestone delivery
Student groups, advisor workflows, document templates, milestone submissions, and review queues stay connected across the UI and API.
- Project lifecycle spans proposal intake, requirements, design, implementation, and final deliverables
- Frontend dashboards expose role-specific queues and progress summaries
- Backend project, milestone, document, and communication modules power the flow
03
Coordinate review, analytics, and defense readiness
Evaluation pipelines, defense scheduling, notifications, analytics, and reporting turn documentation into operational visibility.
- Coordinator and evaluator workspaces support scheduling and score submission
- Backend analytics, notification, and queue services keep everyone aligned
- Documentation becomes more valuable when it mirrors these real operating flows
Product snapshots from the frontend repository
These images make the documentation feel closer to the product teams and stakeholders will actually see.
Landing and platform entry
The public-facing entry point sets expectations for institutions evaluating the platform.
Student workspace
Students manage project submissions, milestone files, and advisor-facing progress from one workspace.
Coordinator operations
Coordinators track assignment health, scheduling, and academic workflow readiness across departments.
Advisor and evaluator dashboards
Review queues, evaluation actions, documents, and defense preparation stay visible for academic staff.
Navigate the docs by intent
The homepage should help people reach the right guide fast, whether they are onboarding a department, tracing the workflow, or working on the product itself.
Start with platform orientation
These pages help new readers understand what Academia is, how departments onboard, and how the system is structured.
- EntryWelcomeStart with the docs entry point and understand the overall scope.
- Getting startedOverviewSee the real product shape, stack, roles, and system direction.
- OnboardingOnboarding and first setupFollow the department-head-first setup flow and invitation sequence.
- SystemArchitectureUnderstand how the frontend, backend, roles, and workflow layers connect.
Follow the operational workflow
These guides map the real academic flow from proposal creation through milestones, evaluation, defense, and department oversight.
- LifecycleProject lifecycleUse the full stage-by-stage map from setup through final defense.
- Deep diveProposal review and approvalGo deep on student submission, reviewer feedback, approval, and project creation.
- Deep diveMilestone delivery and advisor reviewSee upload, feedback, resubmission, approval, and sequential milestone control.
- Late stageEvaluation and defense workflowTrace evaluator scoring, defense scheduling, and student readiness in the late stage.
- OperationsStaff oversight and assignmentUnderstand coordinator and department-head control over assignment and readiness health.
- RolesRoles and dashboardsUse the role map to understand where each user enters and what each workspace owns.
Jump in by role
Use these role guides when you already know the audience you are writing for or onboarding into the platform.
- RoleDepartment headStart with department activation, governance, invitations, and first-run readiness.
- RoleCoordinatorFollow proposal movement, assignment control, and late-stage operational readiness.
- RoleAdvisorGo directly into supervision, milestone review, and feedback-driven project improvement.
- RoleStudentOpen the main workflow journey from proposal through milestones and defense preparation.
- RoleEvaluatorTrace assigned-project review, rubric scoring, and defense-stage participation.
Developer references
These pages are for contributors and integrators who need environment, API, and tenant context rather than product flow.
Follow the strongest documentation paths
These docs track the Academia platform and the open-source client. These entry points take readers into the most complete documentation journeys first.
Role-based workspaces
Dashboards and navigation tailored for department heads, coordinators, advisors, students, and evaluators.
Read more→Workflow deep dives
Move from the lifecycle map into proposal review, milestone delivery, evaluation, defense, and the real operating flow.
Read more→Staff oversight layer
Coordinator and department-head guides explain assignment health, evaluator progress, and operational monitoring.
Read more→