Skip to main content

Documentation completion backlog

Mockup-first rule (read first). Every published screenshot must be framed in the shared static device-mockup generator (phone bezel for Android, tablet frame, browser chrome for web). No raw captures are published directly. Frames are produced by a single reproducible command and stored beside the clean capture. See docs/assets/screenshot-frames/README.md for the generator and usage. This rule applies to the docs portal, the marketing website, and any release evidence.

This is the reproducible completion plan for the screens and features that are implemented but do not yet have an approved screen contract, capture, or user-facing documentation. Work through the bundles in order; each bundle produces code-owned Markdown, automation, and versioned framed screenshots in the same pull request.

Release 1 baseline​

  • Canonical documentation tree, templates, index, role matrix, and release gate.
  • Docusaurus portal build.
  • Storybook foundation for web primitives.
  • Four approved clean captures: web login, Android login, Android operations, Android inventory.
  • Website demo seed profile and release APK verification.
  • Publish the Docusaurus build at the chosen documentation host and point marketing links there.

Sweep — verify or re-capture every existing screenshot​

The namik branch is 42+ commits ahead of dev. Several important features and UI states have changed, so every existing screenshot is considered stale until verified against the current build.

  • Re-verify each existing capture in docs/assets/screenshots/current/, the portal static/media/nox-billings/screenshots/current/, and the website public/nox-billings-*.png against the current namik UI.
  • Mark each capture as Current (still accurate) or Required (must re-capture) in overview/screen-inventory.md.
  • Re-run each Playwright / Maestro flow that produced a capture; do not assume a flow still passes after the refactors in f21c918 (invoice lifecycle), b7816cf (inventory filters), 6d9ac43 (shift reset), and dfbd088 (retry recovery).
  • Replace raw captures with framed versions (mockup-first rule) in the same PR that verifies them.
  • Record the release, commit, device, role, theme, state, source flow, and filename in the manifest for every re-captured image.

New features on namik — documentation status​

Features that shipped on namik and need user-facing documentation. Each row is one checklist item; a feature is done only when it has a guide (or guide section), a portal route, and at least one framed screenshot.

Web operational Planner queue (dbf20fd, 3278914, 3f4623d, f948e00)​

  • Add a "Planner queue" section to guides/run-your-workspace.md (or a new guides/planner-queue.md) describing the web operational queue, work items, draft-invoice linkage (PLN-004), and mobile operational workflow.
  • Capture default, empty, work-item-assigned, and draft-invoice-linked states.
  • Portal route: /nox-billings/guides/planner-queue/.

OCR reviewed supplier invoices (c0054f2, cd811b5)​

  • Extend the OCR guide to cover "confirm reviewed supplier invoice" — the reviewed/confirmed state, tenant-scoped idempotency, and what happens to unconfirmed documents.
  • Capture default, confirmation-required, confirmed, and duplicate-supplier-invoice states.
  • Portal route: extend /nox-billings/guides/receive-count-and-transfer-stock/ or a dedicated OCR guide.

Ledger at-risk exposure (4d85416, 9a4fa5a, 4453ad2, 94e264f, 4f7052f)​

  • Document configurable at-risk exposure, receivable aging buckets, and the aging drill-down to exact unpaid invoices (LDG-005).
  • Capture default, at-risk-threshold-set, aging-drilldown, and supplier-payables states.

Ledger filtered CSV and XLSX exports (f093de5)​

  • Document the filtered export surface (CSV and XLSX), which filters apply, and the export record in the audit log.
  • Capture export-config, export-complete, and download states.

Idempotent domain event hooks (2efc0e2, 5e930b3, f5bc3c1)​

  • Document webhook/event-hook endpoints, idempotency behaviour, deliveries, test, and replay, with tenant scoping (f5bc3c1).
  • Extend SET-SCR-003 (webhooks) captures: endpoint-list, delivery-log, test-delivery, replay, and tenant-scoped states.

Cross-client action summary (bf66b70)​

  • Document the cross-client action summary on the dashboard: what it aggregates, which roles see it, and the drill-down path.
  • Capture default and drill-down states on WEB-SCR-002 (dashboard).

Product location overrides (mobile) (db7f683)​

  • Document mobile product location overrides: where they apply, who can set them, and how they interact with stock.
  • Capture override-set, override-applied-at-sale, and location-restricted states.

Invoice lifecycle and reference validation (f21c918, d658532, 9ba1446)​

  • Document the invoice lifecycle (draft → issued → paid/voided/refunded) and centralised reference validation after the refactor.
  • Re-capture invoice states that changed: draft, issued, void-requested, voided, refunded.

Web inventory server-side filters (b7816cf)​

  • Document server-side inventory filters (category, stock status, location) and pagination behaviour.
  • Re-capture STK-SCR-001 (inventory) with filtered states.

Shift and day-close hardening (e5c6a40, 6d9ac43, 2f51ec4, 24559b1)​

  • Document shift reset, report loading states, cash-movement ownership validation, and inventory reservation scoping.
  • Re-capture SHF-SCR-001, SHF-SCR-002, and the day-close variance flow.

Web operations retry recovery (dfbd088)​

  • Document the retry-recovery behaviour for failed web operations: what is retried, what needs manual review, and the error surface.
  • Capture operation-failed, retry-pending, and recovered states.

Bundle A — point of sale (highest priority)​

  • POS-SCR-001 web POS home: populated, cart, empty, search-no-results, discount/validation, offline, success.
  • POS-SCR-002 Android sell/catalog: default, product-search, cart transition, tablet layout.
  • POS-SCR-003 Android cart: populated, quantity editing, clear-cart confirmation.
  • POS-SCR-004 Android payment: cash, UPI, split payment, failure/retry.
  • POS-SCR-005 Android receipt: success, delivery/print failure, refund entry.
  • Add modules/pos/screens/* contracts and a user guide for cash/UPI sales.
  • Run the Playwright checkout test and Maestro checkout flow to create the named captures.

Bundle B — inventory and operations​

  • STK-SCR-001 through STK-SCR-005: web inventory/OCR and Android stock detail, receiving, cycle count.
  • OPS-SCR-001 through OPS-SCR-008: discounts, approvals, alerts, transfers, and OCR states for web/Android.
  • Add inventory and operations screen contracts, transfer/receiving workflows, and printer/OCR setup guides.
  • Capture manager and owner variants only where behaviour or controls differ.

Bundle C — administration and reporting​

  • ADM-SCR-001 through ADM-SCR-005: products, categories, employees, locations.
  • CRM-SCR-001: customer list/detail/search/empty state.
  • RPT-SCR-001 through RPT-SCR-004: reports, tax, margin, Android insights.
  • SET-SCR-001 through SET-SCR-005: settings, billing configuration, permissions, printer.
  • AUD-SCR-001: audit log and permission-restricted state.
  • Add owner setup and day-end reporting how-to guides.

Mandatory capture matrix per screen​

  • Default populated state.
  • Loading, empty, search-no-results, validation error, network error, offline, success, and destructive confirmation where relevant.
  • Phone and web; tablet and narrow-web when the layout differs.
  • Light and dark theme when the visible design changes.
  • Role variants only when permissions or visible UI differ.
  • Clean source image plus optional annotated image; never overwrite the clean capture.
  • Framed version (mockup-first rule) for every published capture.
  • Manifest record with release, device, role, theme, state, source flow, and filename.