Skip to main content

Documentation completion backlog

This is the reproducible completion plan for the screens that are implemented but do not yet have an approved screen contract or capture. Work through the bundles in order; each bundle produces code-owned Markdown, automation, and versioned 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.

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.
  • Manifest record with release, device, role, theme, state, source flow, and filename.