Platform admin
System design diagram
/admin/system-design renders the complete architecture of
the product as a single, self-contained diagram page: the bird's-eye
topology, the visitor hot path, the knowledge-ingestion pipeline,
Smart Segments, live chat, the self-improvement loop, notifications,
tenancy & security, billing, and infrastructure. It is written for
presenting to stakeholders — every box uses plain language, with the
real class names alongside for engineers.
Access: the page sits inside the platform-admin route
group, so it requires a logged-in super_admin account —
everyone else gets a 404 (the area is existence-hidden, like the rest
of /admin). It also carries noindex, nofollow.
Like the internal Kanban board, there is intentionally no sidebar nav
entry; navigate to the URL directly.
Design choices
| Choice | Why |
|---|---|
| Standalone Blade page, not an Inertia page | It is a printable document, not an app screen — it must render with zero dependency on the admin JS bundle, and it prints cleanly (print styles collapse the layout and hide the table of contents). |
| No generated diagrams / external libraries | Pure HTML + CSS, so the page can never break with the content and adds nothing to any build. |
Version chip from config('app.version') |
The header shows which release the diagram describes; it
tracks .env VERSION automatically. |
Keeping it true
The page names real components (Retriever,
CrawlSourceJob, WidgetJwt, …). When one of
those is renamed or a flow changes shape, update the diagram in the
same commit — the feature test
(tests/Feature/Admin/SystemDesignPageTest) asserts access
protection and spot-checks key content so a broken page fails CI.