Example
Evidence gathered from the current module files before writing the user guide pages.
Research Sources Inspected
Source path
modules/Example
Feature flags marked true
- Controllers
- Models
- Views
- Language
- Permissions
- Left Menu
- Default Menu
- Routes
- Migrations
- Helpers
Evidence Summary
Manifest
module.json defines slug example, version 1.0.0, category Custom, and the module capability flags used in this guide.
Runtime surface
1 controller file(s), 3 view file(s), and 2 route mapping(s) were found.
Data surface
1 model file(s), 1 declared table(s), and 1 migration file(s) were found.
Operations surface
4 permission key(s), 0 job(s), 0 seeder(s), and 0 test file(s) were found.
Detailed File Evidence
Controllers and methods
Example
Jobs and schedules
No scheduled module jobs were found.
Routes sampled
| Route | Target |
|---|---|
example | Example/index |
example/(:any) | Example/$1 |
README topics
- Layout
- Make it visible
- Contracts
Operating Implications
- Permission coverage is part of the module contract, so every workflow should be tested with a role-limited user and an administrator.
- The module has migrations, so fresh installs and tenant databases need migration validation before go-live.
Known Risks from the Manifest
No explicit known_risks list was found in the module manifest. Keep normal module controls in place and validate permissions, data, and public surfaces during QA.