Documentation coverage
This inventory was checked against the development workspace on 2 October 2026. It includes the workspace changes present during review, based on commit ade94a22. The current development guides are separate from the V2 release guides.
The reviewed surface contains 221 registered non-vendor routes, 147 domain action files, and 182 Livewire files. The guides cover all 12 optional features, 13 report types, 2 import types, and 17 application commands. Livewire file coverage includes authentication, layouts, and reusable concerns. These counts describe documentation coverage, not application test coverage.
Each main workflow guide now includes a result check. The screenshot capture brief defines the planned images and the checks required before using them.
The demo guide covers the new destructive hourly reset and isolated evaluation setup.
Workflow entry points
| Entry points | Guide |
|---|---|
Closure | Use the workspace |
InstallationController, LocationController | Local installation |
OrganizationController, OrganizationDashboardController, OrganizationDomainController, OrganizationMemberController, OrganizationBillingGroupController | Organizations and domains |
SchoolController, SchoolSetupController | Campus settings and setup |
ViewController | Optional features |
CampusRoleController | Roles and permissions |
AccountInvitationController, AdminController | Accounts, invitations, and profile security |
StudentController | Students and enrollment |
AdmissionWaitlistController | Admission queues |
ParentController | Parents and guardian links |
CampusMoveRequestController | Campus moves and transfers |
DataSharingRequestController | Share student records between campuses |
AcademicYearController, AcademicPeriodController, AcademicYearSetupController, CalendarTemplateController | Academic calendars and closure |
AcademicLevelController, AcademicCycleSectionController, InstructionalModelController | Levels, sections, and teaching models |
SubjectController, CourseOfferingController, TeacherController | Subjects, course offerings, and teachers |
AttendanceRegisterController | Attendance registers |
TimetableController, CustomTimetableItemController | Timetables and lesson cover |
SyllabusController | Syllabi, coverage, and lesson notes |
ExamController | Exam schedules |
GradebookController, GradingScaleController | Gradebooks and grading scales |
RankingController, ReportCardController, TranscriptController | Result approval and official documents |
PromotionController, GraduationController, GraduationPlanController | Promotion, graduation, and graduation plans |
CalendarEventController | Calendar events and closure days |
NoticeController, NoticeAttachmentController, NoticeNotificationPreferenceController | Notices and email preferences |
IncidentController | Behaviour and safeguarding cases |
StudentHealthRecordController, SupportPlanController | Support plans and health records |
StaffProfileController, StaffLeaveRequestController | Staff records, availability, and leave |
CohortController, ProgramController | Groups and programmes |
FacilityController | Facilities and bookings |
DormitoryController, BoardingRollController, OvernightLeaveController, OrganizationBoardingResidenceController | Boarding houses, rolls, and nights away |
LibraryCopyController, LibraryLoanController, LibraryReservationController, LibraryLendingRulesController | Library catalogue, loans, and reservations |
ImportController | Import student and staff CSV files |
ReportController | Report exports |
FeeCategoryController, FeeController, FeeInvoiceController | Fees and invoices |
StudentAccountController, StudentPaymentController | Payments, credit, refunds, and corrections |
BudgetController, ExpenseController, CashDepositController | Financial periods, expenses, deposits, and budgets |
PortalOverviewController, PortalAttendanceController, PortalBoardingController, PortalCalendarController, PortalDocumentsController, PortalGraduationController, PortalInvoicesController, PortalLibraryController, PortalNoticeController, PortalProgramController, PortalSyllabusController | Family portal |
PortalRequestController | Family requests and the staff inbox |
HealthController | Backups and monitoring |
Role-specific instructions
The role index links instructions for every seeded role and delegated specialist responsibilities. The role inventory records eight installation templates and their permission sets. Local assignments and migration history can differ from those templates. Role checks compare the documented role list and permission snapshot with the source seeders when a checkout is available. Job duties remain campus-defined permission sets, rather than invented seeded roles.
Procedures across application areas
The task guides also connect through these procedures:
| Procedure | Coordinates |
|---|---|
| Daily campus checks | Teaching, office services, finance review, and shift handover. |
| Staff access review | Account, membership, roles, employment, departure, and return. |
| Academic handover | Marks, approval, documents, closure, copied setup, and learner placement. |
| Finance reconciliation | Receipt evidence, allocations, held credit, cash, bank, report scope, and closure. |
| Service recovery | Health checks, queues, scheduler, email, files, and suspected data loss. |
These are staff and operator procedures, not new automatic application workflows. Worked financial totals are expected rehearsal results. They do not claim a completed browser rehearsal.
Review procedure quality
Route coverage is a discovery aid. A mapped guide still needs an executable procedure. For each workflow, review prerequisites, permission scope, exact controls, input rules, saved state, correction steps, and blocked actions. Compare the instructions with the current forms, policies, actions, and relevant tests. The worked exercise gives a manual acceptance sequence with expected outcomes. It does not substitute for running that exercise or testing the application. Planned screenshots remain pending until real captures are added and reviewed.
Review and maintain the inventory
The machine-readable inventory maps each route and source file to its guide. It also records report permissions, import columns, feature keys, and command names.
Recheck the inventory after adding a route, action, component, report, importer, feature, or command. Update the guide and its navigation entry in the same documentation change. The docs checks reject missing guides and broken built links. They can also compare the inventory with a local application checkout and a fresh route export.
See the documentation contribution instructions for the check commands. Authentication package routes are outside the non-vendor route snapshot; the account guide covers their user workflows. Framework internals and third-party package APIs remain in their own package documentation.