Skip to content

Feature Reference

Daniel Hokanson edited this page Aug 30, 2026 · 4 revisions

Forge documents every feature, form field, API endpoint, status lifecycle and validation rule in docs/functional-reference/. That directory is the single source of truth for what the application does. This page is the index.

How to use it: end users find their feature and read the overview plus field reference; developers treat it as the spec when building or modifying; integrators start at the API reference and database schema.

These docs vary in freshness. Where a doc and the code disagree, the code wins and the doc is a bug — two known cases are annotated below. Several substantial subsystems have no reference doc at all yet; those rows point at wiki pages instead.

Base path for every link below: docs/functional-reference/.

Core application

Feature Doc Covers
Application shell app-shell.md Sidebar, header, breadcrumbs, global search, theme, notifications bell, keyboard shortcuts
Dashboard dashboard.md KPI chips, widgets, gridstack layout, focus and ambient modes
Notifications notifications.md Real-time SignalR alerts, panel, preferences, email delivery
Global search search.md Cross-entity search, AI RAG column, Ctrl+K

Production and scheduling

Feature Doc Covers
Kanban board kanban.md Track types, stages, drag-drop, WIP limits, job cards, bulk actions, live sync
Backlog backlog.md Prioritised job queue, filters, table/card views, job creation
Planning cycles planning.md Sprint-style planning, drag-to-commit, rollover, cycle progress
Shop floor shop-floor.md Kiosk display, RFID/badge/barcode auth, worker cards, clock actions, job timers
Calendar calendar.md Job calendar, PO deliveries, month/week/day views
Scheduling scheduling.md Gantt, dispatch lists, work centers, shifts, capacity load
MRP mrp.md Material requirements planning, planned orders, exceptions, forecasting
OEE oee.md Overall equipment effectiveness

Engineering and quality

Feature Doc Covers
Parts catalog parts.md Parts, BOM, operations, routing, revisions, alternates, pricing, serials, 3D STL viewer
Inventory inventory.md Stock, locations, movements, receiving, cycle counts, reservations, UOM, replenishment
Quality & QC quality.md Templates, inspections, SPC, NCRs, CAPAs, ECOs, gages, PPAP, FMEA, lot tracking
Assets assets.md Asset registry, tooling, maintenance schedules, downtime, Six Big Losses
Production lots lots.md Lot creation, traceability query, origin tracking

Sales and CRM

Feature Doc Covers
Leads leads.md Pipeline stages, table/pipeline views, conversion to customer
Customers customers.md Profiles, contacts, addresses, interactions, detail tabs, stats bar
Estimates estimates.md Non-binding ballpark figures, conversion to quotes
Quotes quotes.md Line-itemised binding quotes, acceptance, conversion to sales orders
Sales orders sales-orders.md Order management, lines, fulfilment tracking, drop-ship

Procurement and fulfilment

Feature Doc Covers
Vendors vendors.md Profiles, scorecards, addresses, accounting boundary
Purchase orders purchase-orders.md Creation, lines, receiving, blanket POs, releases
Purchasing / RFQs purchasing.md RFQ workflow, vendor comparison, award, PO auto-generation
Shipments shipments.md Packing, shipping, carrier integration, tracking, labels. Stale: the doc says carrier APIs are "planned but not yet implemented"; real adapters ship with rate-shopping and label purchase — Configuration and Integrations

Finance

Feature Doc Covers
Invoices invoices.md Lifecycle, lines, tax, PDF generation, email ⚡
Payments payments.md Recording, invoice application, methods ⚡
Expenses expenses.md Capture, receipt upload, approval workflow, recurring templates
Payroll payroll.md Pay stubs, tax documents, deductions, employee self-service
Sales tax sales-tax.md Per-jurisdiction rates, effective dates, customer rate lookup

⚡ = behaviour depends on Accounting Modes.

People and administration

Feature Doc Covers
Admin panel admin.md Users, roles, track types, reference data, terminology, settings
Authentication & MFA auth.md Login, SSO, TOTP MFA, tiered kiosk auth, setup tokens, recovery codes
Employee account account.md Profile, security, customisation, compliance forms, pay stubs
Time tracking time-tracking.md Timers, manual entry, corrections, clock events, pay periods, overtime
Compliance forms compliance.md W-4, I-9, state withholding, dynamic forms, PDF extraction, e-signing
Events events.md Meetings, trainings, safety events, attendees, RSVP, reminders
Employees employees.md Employee management, profiles, teams, shifts, scan identifiers
Approvals approvals.md Multi-step workflows, delegation, escalation, audit trail
Leave management leave.md Policies, accrual rates, balance tracking, request workflow
Onboarding onboarding.md New-employee wizard, profile completion, guided setup

Communication and AI

Feature Doc Covers
Chat chat.md 1:1 DMs, group rooms, SignalR real-time, slide-out panel
AI assistant ai.md Ollama RAG, configurable assistants, document Q&A, smart search
Training (LMS) training.md Modules, paths, articles, walkthroughs, quizzes, progress tracking
EDI edi.md X12/EDIFACT trading partners, transaction lifecycle, field mappings

Reporting and returns

Feature Doc Covers
Reports reports.md Pre-built reports, dynamic builder, entity sources, Sankey diagrams, export
Customer returns customer-returns.md RMA lifecycle, inspection, rework job creation, resolution

System and infrastructure

Feature Doc Covers
File storage file-storage.md MinIO S3 storage, uploads, chunked upload, lightbox gallery, camera capture
Status lifecycle status-lifecycle.md Polymorphic status tracking, workflow and holds, timeline component
Barcode & scanning scanning.md USB scanner, NFC/RFID, QR codes, label printing, context-aware routing
Real-time (SignalR) signalr.md Board, notification, timer and chat hubs; reconnection, connection banner
Offline & PWA offline.md Service worker, IndexedDB cache, offline action queue, sync conflicts
Workflow engine workflow-engine.md The workflow/state model behind entity lifecycles
Capabilities capabilities.md Feature gating — see Capability Gating

Cross-cutting references

Document Covers
API reference Authentication, pagination, error format, endpoints by domain. Says nothing about API keys, idempotency or webhooks — start at API Access
Database schema Entities, relationships, enums, pgvector, naming conventions
Roles & permissions Roles, feature access matrix, API permissions, kiosk tiers, MFA policy
Integrations Accounting, shipping, USPS, Ollama AI, MinIO, e-signing, SMTP, Hangfire. Predates the current settings system — Configuration and Integrations is authoritative on where credentials live

Documented on the wiki, no reference doc yet

Subsystem Where
Gated sequences, approvals and the workflow engine [[Workflow, Gates and Approvals
Sales channels, retail and marketplace Business Shapes
Label overrides, languages and branding Customizing an Install
Roles, role templates and MFA Access and Roles
Communications capture (mailbox and call logging) Off by default; see the CROSS capabilities in the catalog

Clone this wiki locally