Appearance
What is documented, and what is not
This guide is honest about its own gaps. The application has 112 destination screens; this guide has 221 published pages, but those two numbers are not aligned — most of the pages document process engineering (clarifier settling, biokinetics, controller tuning, hydraulics) rather than the application. Of the 221 pages, 67 mention a button, panel, tab, or menu at all; the rest are reference material you would read beside the screen, not instructions for using it.
So: deep domain documentation, lighter application documentation. This page says exactly where that falls, screen by screen, so you do not spend ten minutes searching for a page that was never written.
How to read the verdicts:
| Verdict | Means |
|---|---|
| Documented | A page here describes that screen — where it is, what it does, how to work it. |
| Partial | The screen is named or passed through by another page (a step in a longer task, or a search scope), but has no page of its own. |
| Not documented | Nothing in this guide describes it. Use it from the app; it is not covered here. |
| Out of scope | A public website page, or an internal demo surface. Deliberately not documented here. |
Counts are of destination screens. The application also declares 21 redirect-only aliases (old paths kept working) and one catch-all; those are not listed, because there is nothing to document about a redirect.
Drawing and the P&ID editor
| Screen | Verdict | Where |
|---|---|---|
/draw — the editor | Documented | Drawing — 13 pages |
/shared/:token — a drawing shared by link | Partial | Creating a Drawing names share links |
/admin/drawings — the drawings list | Partial | reached from several pages; no page describes the list itself |
/admin/drawing-register — company drawing register | Not documented | — |
/admin/pid-models — P&ID model list | Not documented | — |
/admin/pid-models/:id/editor | Documented | P&ID model editor |
/admin/pid-models/:id/register | Not documented | — |
/admin/symbol-library — symbol library manager | Partial | Drawing Overview covers the in-editor symbol panel, not the manager |
/symbol-studio/:symbolId — symbol studio | Not documented | — |
/catalogue-editor — client catalogue editor | Partial | Client Standards |
Templates
| Screen | Verdict | Where |
|---|---|---|
/templates — template gallery | Partial | referenced from Drawing Templates and Plant Templates |
/templates/:id — template detail | Partial | as above |
/templates/new — new template builder | Not documented | — |
/templates/studio/:slug — template studio | Not documented | — |
/drawings/:drawingId/units/:instanceId — template workspace | Not documented | — |
/admin/drawing-templates — drawing template admin | Not documented | — |
/admin/templates — template enablement (admin) | Not documented | — |
Simulation
| Screen | Verdict | Where |
|---|---|---|
/simulation/editor — flowsheet editor | Documented | Building a Flowsheet |
/admin/simulation — simulation workspace | Partial | Simulation covers the engine, not the workspace |
/admin/simulations — simulation runs list | Partial | as above |
/models — model list | Partial | linked from several process-unit pages |
/models/:id — model detail | Partial | as above |
/admin/models — model coordination (Models / Views / Clashes / Issues) | Not documented | — |
The engineering behind simulation is the best-covered part of this guide: Process Units (99 pages), Controllers (13), Design Calculations (10), Simulation (17), Hydraulics, Clarifier Models. Those pages are reference, not screen instructions, and that is correct for what they are — do not expect a tutorial inside a settling-model page.
Bill of materials and components
| Screen | Verdict | Where |
|---|---|---|
/admin/bom — BOM list | Documented | Bill of Materials |
/admin/bom/:id — BOM detail | Documented | as above |
/admin/bom/:drawingId/:nodeId — BOM item from a drawing node | Documented | as above |
/admin/bom/item/:id — BOM item lifecycle hub | Not documented | — |
/precision/reports/bom — BOM report | Not documented | — |
/admin/components — component library | Not documented | — |
/admin/components/new, /:id, /:id/edit | Not documented | — |
/admin/suppliers — suppliers | Not documented | — |
Projects, planning, and carbon
| Screen | Verdict | Where |
|---|---|---|
/admin/projects — projects list | Partial | reached from Planning, Carbon, Design Calculations |
/admin/projects/new — new project wizard | Partial | Creating Projects describes a "File → New Project" menu the application does not have — treat it as stale |
/admin/projects/:id — project detail (incl. the Carbon tab) | Documented (Carbon tab) | Using the Carbon Tab; the other tabs are not covered |
/admin/projects/:projectId/schedule — the planner | Documented | Planner, Schedules |
/precision/reports/timeline — timeline report | Not documented | — |
/admin/clients — clients | Not documented | — |
Safety analysis
Every safety screen is documented. This is the most complete application coverage in the guide.
| Screen | Verdict | Where |
|---|---|---|
/hazop/studies, /hazop/studies/:studyId | Documented | HAZOP |
/fmea/worksheets, /fmea/worksheets/:id | Documented | FMEA |
/sil/assessments, /sil/assessments/:id | Documented | SIL |
/lopa/studies, /lopa/studies/:id | Documented | LOPA |
/dsear/assessments, /dsear/assessments/:id | Documented | DSEAR |
Documents, review, and site coordination
This is the largest uncovered block in the application — ten screens, no pages.
| Screen | Verdict | Where |
|---|---|---|
/admin/documents — document register, folders, transmittals | Not documented | — |
/admin/documents/transmittals/:id — transmittal detail | Not documented | — |
/shared/transmittal/:token — a transmittal shared by link | Not documented | — |
/admin/design — design collaboration (Home / Issues / Project Status / Changes) | Not documented | — |
/admin/rfis, /admin/rfis/:id | Not documented | named only as a search scope in Finding Things |
/admin/submittals | Not documented | as above |
/admin/meetings | Not documented | — |
/admin/issues, /admin/issues/:id | Not documented | — |
Workflows, agents, and AI
| Screen | Verdict | Where |
|---|---|---|
/admin/workflows — workflow admin | Documented | Starting a Workflow, Building a Template |
/admin/workflows/:id — workflow detail | Documented | as above |
/admin/ai-providers — AI provider setup | Documented | AI provider setup |
/chatbot — the assistant | Partial | AI provider setup explains what happens when AI is unavailable |
/admin/agents — agent catalogue | Not documented | — |
/admin/agent-dashboard — project agent dashboard | Not documented | — |
/admin/agent-workflows, /new, /:id — agent workflow builder | Not documented | — |
/automation-center | Not documented | — |
/machines | Not documented | — |
Import and mapping
| Screen | Verdict | Where |
|---|---|---|
/admin/imports — import sessions | Not documented | — |
/admin/symbol-mappings — saved symbol mapping sets | Not documented | — |
/settings/import-mappings — your own mapping tables — is also undocumented. It is one of the five screens behind the single /settings/* route, so it is counted there rather than as a destination of its own.
In-editor import and recognition are covered — Importing a P&ID, Reviewing Recognition Results, Identifying Hotspots — but the admin-side session list and the mapping-set library are not.
Knowledge base, search, and help
| Screen | Verdict | Where |
|---|---|---|
/search — global search | Documented | Finding Things |
/admin/knowledge-base — knowledge base | Not documented | — |
/learn | Documented | Learn: guided courses |
/support | Not documented | — |
/discover | Not documented | — |
/approvals — approvals inbox | Partial | the Workflows pages cover approval steps, not the inbox |
/solutions — in-app solutions | Not documented | — |
Account, settings, and platform administration
| Screen | Verdict | Where |
|---|---|---|
/home — the home dashboard | Partial | Interface Overview describes the editor shell, not this page |
/register | Partial | Account Setup describes account creation generically |
/invitations/:token — accepting an invitation | Partial | as above |
/login, /login/sso-complete, /forgot-password, /reset-password | Not documented | — |
/profile, /precision/settings/profile | Partial | Account Setup, step 9 |
/settings/profile, /notifications, /team, /billing | Partial | Account Setup covers preferences, not these screens |
/admin — the admin landing page | Partial | reached from several pages |
/admin/companies, /admin/companies/:id | Not documented | — |
/admin/features — feature flags | Not documented | — |
/admin/reference-data | Not documented | — |
/admin/system-logs | Not documented | — |
Collaboration behaviour that is not one screen — real-time editing and notifications — is documented.
Out of scope
The public website (/, /about, /products, /products/:slug, /features/:slug, /solutions/:slug, /pricing, /security, /what-is-an-intelligent-pid, /book-demo, /contact, /cookies, /privacy, /terms) is marketing and legal copy, not product documentation. Two internal surfaces (/showcase/mbep, /spike/landing-demo) and one placeholder (/flows/new) are development aids. None of these belong in a user guide.
The tally
| Screens | |
|---|---|
| Documented | 21 |
| Partial | 21 |
| Not documented | 53 |
| Out of scope | 17 |
| Total destination screens | 112 |
Read that as: the drawing editor, the five safety studies, the BOM, the planner, workflows, search, carbon, and AI setup are documented. Everything around documents and review, agents, model coordination, components and suppliers, the template admin surfaces, and most of platform administration is not.
Pages this guide links to but does not contain
Sixty page names are cross-referenced from inside the guide but were never written. Those references render as plain text, not as broken links — but the reader still does not get the page. The largest clusters:
- Process fundamentals — Nitrification Fundamentals, Denitrification, BNR Fundamentals, EBPR / EBPR Fundamentals, Biofilm Theory, Oxygen Transfer, Sludge Settleability, State Point Analysis, Selector Design
- Named process configurations — A2O, MLE, UCT, Bardenpho, Orbal, Carrousel, Extended Aeration, High-Rate Activated Sludge, Step-Feed Activated Sludge, Simultaneous Nitrification–Denitrification, Deammonification, NEREDA, Membrane Bioreactor, IC Reactor, EGSB, Aerated Lagoon, Constructed Wetlands, Natural Treatment Systems, Dissolved Air Flotation, Contact Tank, Humus Tank, Lamella Secondary Clarifier, Two-Stage Filters
- Chemical dosing — the category is described as 24 units; the directory has no pages at all, and
Process-Units/Chemical-Dosing/Overviewis referenced eleven times - Equipment and ancillaries — Pumps, Aeration Systems, Activated Sludge Basin, WAS System, Air Treatment, Odour Control, Compost Biofilter, VOC Removal, Cryogenic Oxygen, Ion Exchange, Remineralisation, pH Adjustment, Backwash Optimisation, Pathogen Removal, Algae Harvesting, Biogas Utilisation, Industrial Wastewater, Storm Water Treatment
- Control and solver topics — PID Controller (referenced eighteen times, and the only controller type in the product without its own page), SBR Control Strategies,
Controllers/Advanced-Control,Simulation/Advanced-Solvers,Design-Calculations/Energy-Analysis, Simulation Engine
Structural duplication in the tree
Five process-unit categories exist twice, under two naming schemes, with different contents:
| Short tree | Long tree |
|---|---|
Process-Units/Preliminary/ (3 pages) | Process-Units/Preliminary-Treatment/ (10) |
Process-Units/Primary/ (2) | Process-Units/Primary-Treatment/ (3) |
Process-Units/Secondary/ (6) | Process-Units/Secondary-Treatment/ (6) |
Process-Units/Sludge/ (3) | Process-Units/Sludge-Treatment/ (16) |
Process-Units/Tertiary/ (2) | Process-Units/Tertiary-Treatment/ (19) |
Six page names therefore exist twice — Secondary Clarifier, MBR, MBBR, SBR, Biogas Production, and the Chemical Dosing overview — which is why a cross-reference to one of them resolves to neither. The same split exists between Platform API and Reference → API, and between Drawing Templates (the parametric P&ID stack) and Plant Templates (the pre-built plant library). Consolidating these is a content job, not a navigation job, and is not done.
Broken cross-references in the published site
A link check over the built site — 1,814 internal links across 222 pages — finds 60 dead links. They cluster, and none of them is a navigation entry (the sidebar is generated from the tree, so a sidebar link cannot 404):
| Count | Target | Why |
|---|---|---|
| 32 | Process-Units/README.md | Ten sludge pages link to the tree's internal authoring note, which is deliberately not published (most link it three times — from a header, a footer and a "see also") |
| 2 | Process-Units/templates/process-unit-template.md | the blank authoring template, also deliberately unpublished |
| 2 | Process-Units/Sludge-Treatment/IMPLEMENTATION_STATUS.md | a per-task progress log, unpublished as of this change |
| 22 | a page that does not exist, or a directory with no landing page | the Overview of five process-unit categories, Chemical-Dosing/Overview, Flow/Pumps-Blowers, Biokinetic-Models/Overview, Basic-vs-Advanced-Mode, Secondary/RBC, and bare Simulation/ and Controllers/ directory links |
| 2 | files outside this guide | Getting-Started/Keyboard-Shortcuts.md offers a printable PDF at ../assets/, and Process-Units/Secondary/MBR.md links a developer page under docs/04-features/ |
The last row is worth reading twice. This site's source directory isdocs/10-user-guide/, so a link that climbs above it cannot resolve — the internal-documentation boundary is enforced by the filesystem, not by a blocklist, and those two links 404 rather than leaking. The right fix is to remove the links (or move the PDF inside this tree), not to widen the boundary.
How this page was produced
Routes were enumerated from packages/web/app/AppRoot.tsx and packages/web/app/routes/publicRoutes.ts — 134 route declarations, of which 21 are redirect-only aliases and one is a catch-all, leaving 112 destinations. Child routes of the five wildcard mounts (/settings/*, /admin/documents/*, /admin/design/*, /admin/models/*, /draw/*) were read from the modules that own them. Coverage was then assessed by searching this guide for each screen.
Keep this page current when you add a page: move its row from Not documented to Documented and correct the tally. A coverage page that silently goes stale is worse than none.