Interactive, multi-page HTML documentation for the Helpdesk module (Tickets, Knowledge Base, Internal Wiki, Web Pages & Help Center, and the AkbAI Company Handbook).
How to view
Open index.html in any browser (no server or build step required — it also works from
file://). The pages are self-contained and share assets/styles.css + assets/app.js.
Contents
| Page | Covers |
|---|---|
index.html |
Overview — what the module is, the pillars, architecture, personas |
getting-started.html |
Enable the module, sub-toggles, RBAC setup, navigation |
tickets.html |
Ticket lifecycle, statuses, types/SLA, groups, templates, collaborators, comments |
tickets-email.html |
Email-to-ticket (IMAP), notifications, signatures, auto-close automation |
knowledge-base.html |
Public self-service KB — categories, articles, publishing, guest access |
wiki.html |
Internal Wiki — staff-only how-to articles |
pages.html |
Web Pages, public /about/{slug}, short-link sharing, Help Center landing |
handbook.html |
AkbAI Company Handbook — PDF → AI sectioning → review → publish |
api.html |
Integration REST API + End-User API reference |
permissions.html |
Full RBAC permission matrix (filterable) |
glossary.html |
Terminology + status/badge/icon legends |
faq.html |
FAQ & troubleshooting |
Features
- Cross-page search (press <kbd>/</kbd>), dark/light theme toggle, auto on-page table of contents with scroll-spy, copy-to-clipboard code blocks, filterable tables, and a mobile-friendly collapsible sidebar.
Demo seeding
If you are on a fresh tenant with Helpdesk enabled and want starter ticketing data, use:
php erpat db:seed Helpdesk [--tenant=<company_key>|--all|--dry-run]This loads modules/Helpdesk/seeders/HelpdeskSeeder.php with:
- Sample ticket types (
Incident / Service Outage,Question / How-to,Request / Enhancement) - Ticket templates mapped to those types
- Ticket groups (
Support Queue,Feature Requests)
The seeder is idempotent by title and supports dry-run previews before writing.
Maintaining
The documentation is generated from the module source under modules/Helpdesk/. When you
change a pillar's behavior (routes, permissions, statuses, API, cron), update the matching
page. The design system lives entirely in assets/styles.css and assets/app.js — all
pages reference the shared component classes documented there; do not add per-page <style>
or <script> blocks.