Vendor docs — E2E specs & screenshots checklist
Nội dung này hiện chưa có sẵn bằng ngôn ngữ của bạn.
| Version | Date (UTC) | Summary |
|---|---|---|
| 1.0.0 | 2026-09-24 | Initial: P0/P1/P2 specs + screenshots matrix for all vendor guide pages |
Overview
Section titled “Overview”This page is the single source of truth for vendor-web E2E automation and documentation screenshots.
- Every vendor guide page (
guides/vendor/**) needs at least one screenshot inapps/docs/public/screenshots/vendor/. - Critical pages (revenue / money) need a Playwright spec under
apps/vendor-web/e2e/vendor/. - Screenshot specs live in
apps/vendor-web/e2e/vendor/**/docs-screenshots.spec.ts. - Screenshots are generated with
PLAYWRIGHT_UPDATE_DOCS_SCREENSHOTS=1 npm run vendor:test:e2e.
Naming conventions
Section titled “Naming conventions”Screenshots
Section titled “Screenshots”apps/docs/public/screenshots/vendor/<area>/<page>-<variant>.pngarea=getting-started,sales,catalog,inventory,customers,finance,employees,schedule,stores,settings,accountpage= slug của page (e.g.orders-list,create-order)variant= tùy chọn (e.g.empty,with-data,modal)
E2E specs
Section titled “E2E specs”apps/vendor-web/e2e/vendor/<area>/<flow>.spec.tsarea= cùng area như screenshotsflow= mô tả ngắn gọn (e.g.orders-list.spec.ts,create-order.spec.ts)
Playwright fixtures (shared helpers)
Section titled “Playwright fixtures (shared helpers)”All vendor E2E specs reuse helpers from apps/vendor-web/e2e/fixtures/ (to be created in Phase 0):
export const vendorFixtures = { loginAsOwner: async ({ page }) => { /* ... */ }, loginAsEmployee: async ({ page }, options?: { module?: string }) => { /* ... */ }, selectStore: async ({ page }, storeId?: string) => { /* ... */ }, goto: async ({ page }, path: string) => { /* ... */ },};Priority levels
Section titled “Priority levels”| Priority | Meaning | Release gate |
|---|---|---|
| P0 | Revenue-critical: wrong behavior loses money, stock, or trust | Required before “vendor E2E ready” |
| P1 | Important operations | Recommended before major releases |
| P2 | Config / lower-traffic | Backlog |
Screenshots checklist
Section titled “Screenshots checklist”Getting started
Section titled “Getting started”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/getting-started/login | getting-started/login.png | auth | P0 | ✅ done (renamed from vendor-login-sign-in.png) |
guides/vendor/getting-started/auth-account | getting-started/login.png, getting-started/forgot-password.png, getting-started/verify-otp.png, getting-started/reset-password.png, account/profile-page.png | auth | P0 | 🔲 todo (docs + e2e spec staged; run npm run test:e2e:auth-account:docs in apps/vendor-web) |
guides/vendor/getting-started/first-store | getting-started/first-store-wizard.png | form | P0 | 🔲 todo |
guides/vendor/getting-started/dashboard-tour | getting-started/dashboard-home.png, getting-started/sidebar-navigation.png | page | P0 | 🔲 todo |
guides/vendor/getting-started/roles-and-modules | getting-started/role-matrix-overview.png | table | P0 | 🔲 todo |
guides/vendor/getting-started/role-matrix | getting-started/role-matrix-full.png | table | P0 | 🔲 todo |
| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/sales/orders | sales/orders-list.png, sales/order-detail.png | list + detail | P0 | 🔲 todo |
guides/vendor/sales/create-order | sales/create-order-form.png | form | P0 | 🔲 todo |
guides/vendor/sales/wholesale | sales/wholesale-orders-list.png | list | P0 | 🔲 todo |
guides/vendor/sales/create-wholesale | sales/create-wholesale-form.png | form | P0 | 🔲 todo |
guides/vendor/sales/returns-and-refunds | sales/returns-list.png, sales/refund-approval-form.png | list + modal | P0 | 🔲 todo |
guides/vendor/sales/deliveries | sales/deliveries-list.png | list | P1 | 🔲 todo |
guides/vendor/sales/work-shifts | sales/work-shifts-list.png, sales/open-shift-dialog.png, sales/close-shift-dialog.png | list + modal | P0 | 🔲 todo |
guides/vendor/sales/pos-workspace | sales/pos-workspace.png | page | P0 | 🔲 todo |
guides/vendor/sales/role-matrix | sales/role-matrix.png | table | P0 | 🔲 todo |
Catalog
Section titled “Catalog”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/catalog/products | catalog/products-list.png, catalog/product-detail.png | list + detail | P0 | 🔲 todo |
guides/vendor/catalog/create-and-edit-product | catalog/create-product-form.png, catalog/edit-product-form.png | form | P0 | 🔲 todo |
guides/vendor/catalog/categories | catalog/product-categories-list.png | list | P1 | 🔲 todo |
guides/vendor/catalog/units-attributes-tags-brands | catalog/units-list.png | list | P1 | 🔲 todo |
guides/vendor/catalog/store-taxes | catalog/store-taxes-list.png | list | P1 | 🔲 todo |
guides/vendor/catalog/suppliers | catalog/suppliers-list.png, catalog/supplier-detail.png | list + detail | P1 | 🔲 todo |
guides/vendor/catalog/smart-import | catalog/smart-import-form.png | form | P1 | 🔲 todo |
guides/vendor/catalog/price-lists-and-rules | catalog/price-lists-list.png, catalog/price-list-detail.png | list + detail | P1 | 🔲 todo |
guides/vendor/catalog/price-approvals | catalog/price-approvals-list.png | list | P1 | 🔲 todo |
guides/vendor/catalog/gallery | catalog/gallery-page.png | page | P1 | 🔲 todo |
guides/vendor/catalog/marketing-banners | catalog/banners-list.png | list | P1 | 🔲 todo |
guides/vendor/catalog/addons | — | placeholder | P2 | ⏭️ skip |
guides/vendor/catalog/role-matrix | catalog/role-matrix.png | table | P0 | 🔲 todo |
Inventory
Section titled “Inventory”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/inventory/warehouses | inventory/warehouses-list.png, inventory/warehouse-detail.png | list + detail | P0 | 🔲 todo |
guides/vendor/inventory/stocks | inventory/stocks-list.png | list | P0 | 🔲 todo |
guides/vendor/inventory/purchase-lots | inventory/lots-list.png, inventory/lot-detail.png | list + detail | P1 | 🔲 todo |
guides/vendor/inventory/adjustments | inventory/adjustment-form.png, inventory/adjustments-list.png | form + list | P0 | 🔲 todo |
guides/vendor/inventory/inter-store-borrow | inventory/inter-store-borrow-form.png | form | P1 | 🔲 todo |
guides/vendor/inventory/internal-transfers | inventory/internal-transfer-form.png | form | P1 | 🔲 todo |
guides/vendor/inventory/role-matrix | inventory/role-matrix.png | table | P0 | 🔲 todo |
Customers
Section titled “Customers”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/customers/customers | customers/customers-list.png, customers/customer-detail.png | list + detail | P0 | 🔲 todo |
guides/vendor/customers/customer-categories | customers/customer-categories-list.png | list | P1 | 🔲 todo |
guides/vendor/customers/memberships | customers/memberships-list.png | list | P1 | 🔲 todo |
guides/vendor/customers/discounts | customers/discounts-list.png | list | P1 | 🔲 todo |
guides/vendor/customers/role-matrix | customers/role-matrix.png | table | P0 | 🔲 todo |
Finance
Section titled “Finance”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/finance/transactions | finance/transactions-list.png | list | P0 | 🔲 todo |
guides/vendor/finance/expenses | finance/expenses-list.png | list | P0 | 🔲 todo |
guides/vendor/finance/refunds | finance/refunds-list.png | list | P0 | 🔲 todo |
guides/vendor/finance/invoices | finance/invoices-list.png | list | P0 | 🔲 todo |
guides/vendor/finance/receivables | finance/receivables-list.png | list | P0 | 🔲 todo |
guides/vendor/finance/sales-overview | finance/sales-overview.png | report | P0 | 🔲 todo |
guides/vendor/finance/sales-report | finance/sales-report.png | report | P0 | 🔲 todo |
guides/vendor/finance/reports-hub | finance/reports-hub.png | page | P0 | 🔲 todo |
guides/vendor/finance/taxes-report | finance/taxes-report.png | report | P1 | 🔲 todo |
guides/vendor/finance/closeout | finance/closeout-list.png | list | P1 | 🔲 todo |
guides/vendor/finance/role-matrix | finance/role-matrix.png | table | P0 | 🔲 todo |
Employees
Section titled “Employees”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/employees/employees | employees/employees-list.png, employees/employee-detail.png | list + detail | P0 | 🔲 todo |
guides/vendor/employees/create-employee | employees/create-employee-form.png | form | P0 | 🔲 todo |
guides/vendor/employees/roles | employees/roles-list.png | list | P0 | 🔲 todo |
guides/vendor/employees/managers | employees/managers-list.png | list | P1 | 🔲 todo |
guides/vendor/employees/employee-tips | employees/employee-tips.png | page | P1 | 🔲 todo |
guides/vendor/employees/role-matrix | employees/role-matrix.png | table | P0 | 🔲 todo |
Schedule / HR
Section titled “Schedule / HR”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/schedule/schedule-admin | schedule/schedule-admin.png | page | P0 | 🔲 todo |
guides/vendor/schedule/my-schedule | schedule/my-schedule.png | page | P1 | 🔲 todo |
guides/vendor/schedule/attendance-detail | schedule/attendance-detail.png | detail | P0 | 🔲 todo |
guides/vendor/schedule/leave-requests | schedule/leave-requests-list.png | list | P0 | 🔲 todo |
guides/vendor/schedule/my-leaves | schedule/my-leaves.png | page | P1 | 🔲 todo |
guides/vendor/schedule/leave-history | schedule/leave-history.png | page | P1 | 🔲 todo |
guides/vendor/schedule/hr-dashboard | schedule/hr-dashboard.png | page | P0 | 🔲 todo |
guides/vendor/schedule/timesheet-report | schedule/timesheet-report.png | report | P0 | 🔲 todo |
guides/vendor/schedule/hr-settings | schedule/hr-settings.png | page | P1 | 🔲 todo |
guides/vendor/schedule/role-matrix | schedule/role-matrix.png | table | P0 | 🔲 todo |
Stores
Section titled “Stores”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/stores/stores | stores/stores-list.png | list | P0 | 🔲 todo |
guides/vendor/stores/create-store | stores/create-store-form.png | form | P0 | 🔲 todo |
guides/vendor/stores/store-configuration | stores/store-configuration.png | page | P0 | 🔲 todo |
guides/vendor/stores/availability | stores/availability-template.png | page | P1 | 🔲 todo |
guides/vendor/stores/role-matrix | stores/role-matrix.png | table | P0 | 🔲 todo |
Settings
Section titled “Settings”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/settings/settings-hub | settings/settings-hub.png | page | P0 | 🔲 todo |
guides/vendor/settings/general | settings/general-settings.png | page | P1 | 🔲 todo |
guides/vendor/settings/notifications | settings/notifications-settings.png | page | P1 | 🔲 todo |
guides/vendor/settings/devices | settings/devices-settings.png | page | P0 | 🔲 todo |
guides/vendor/settings/receipt-template | settings/receipt-template.png | page | P1 | 🔲 todo |
guides/vendor/settings/invoice-template | settings/invoice-template.png | page | P1 | 🔲 todo |
guides/vendor/settings/smtp | settings/smtp-settings.png | page | P1 | 🔲 todo |
guides/vendor/settings/shift-templates | settings/shift-templates.png | page | P0 | 🔲 todo |
guides/vendor/settings/checkout-lanes | settings/checkout-lanes.png | page | P0 | 🔲 todo |
guides/vendor/settings/terminals | settings/terminals-list.png | list | P0 | 🔲 todo |
guides/vendor/settings/hardware-labs | — | internal | P2 | ⏭️ skip |
guides/vendor/settings/role-matrix | settings/role-matrix.png | table | P0 | 🔲 todo |
Account
Section titled “Account”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/account/profile | account/profile-page.png | page | P0 | 🔲 todo |
guides/vendor/account/notifications-feed | account/notifications-feed.png | page | P0 | 🔲 todo |
guides/vendor/account/billing | account/billing-page.png | page | P0 | 🔲 todo |
guides/vendor/account/support-tickets | account/support-tickets.png | page | P0 | 🔲 todo |
Admin-only
Section titled “Admin-only”| Doc page | Screenshot(s) needed | Type | Priority | Status |
|---|---|---|---|---|
guides/vendor/admin-only/system-pages | — | owner-only | P2 | ⏭️ skip |
guides/vendor/admin-only/platform-membership | — | owner-only | P2 | ⏭️ skip |
E2E Playwright specs checklist
Section titled “E2E Playwright specs checklist”Getting started
Section titled “Getting started”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/login.spec.ts | — (already exists) | — | P0 | ✅ done |
e2e/vendor/getting-started/auth-account.spec.ts | — (functional) | getting-started/auth-account | P0 | ✅ done (staged — see npm run test:e2e:auth-account) |
e2e/vendor/getting-started/docs-auth-screenshots.spec.ts | forgot-password.png, verify-otp.png, reset-password.png | getting-started/auth-account | P0 | ✅ done (staged — see npm run test:e2e:auth-account:docs) |
e2e/vendor/getting-started/dashboard-home.spec.ts | dashboard-home.png, sidebar-navigation.png | getting-started/dashboard-tour | P0 | 🔲 todo |
e2e/vendor/getting-started/navigation.spec.ts | sidebar-navigation.png | getting-started/dashboard-tour | P1 | 🔲 todo |
| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/sales/orders-list.spec.ts | orders-list.png, order-detail.png | sales/orders | P0 | 🔲 todo |
e2e/vendor/sales/create-order.spec.ts | create-order-form.png | sales/create-order | P0 | 🔲 todo |
e2e/vendor/sales/wholesale.spec.ts | wholesale-orders-list.png, create-wholesale-form.png | sales/wholesale, sales/create-wholesale | P0 | 🔲 todo |
e2e/vendor/sales/returns.spec.ts | returns-list.png, refund-approval-form.png | sales/returns-and-refunds | P0 | 🔲 todo |
e2e/vendor/sales/deliveries.spec.ts | deliveries-list.png | sales/deliveries | P1 | 🔲 todo |
e2e/vendor/sales/work-shifts.spec.ts | work-shifts-list.png, open-shift-dialog.png, close-shift-dialog.png | sales/work-shifts | P0 | 🔲 todo |
e2e/vendor/sales/pos-workspace.spec.ts | pos-workspace.png | sales/pos-workspace | P0 | 🔲 todo |
Catalog
Section titled “Catalog”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/catalog/products-list.spec.ts | products-list.png, product-detail.png | catalog/products | P0 | 🔲 todo |
e2e/vendor/catalog/create-product.spec.ts | create-product-form.png | catalog/create-and-edit-product | P0 | 🔲 todo |
e2e/vendor/catalog/categories.spec.ts | product-categories-list.png | catalog/categories | P1 | 🔲 todo |
e2e/vendor/catalog/price-lists.spec.ts | price-lists-list.png, price-list-detail.png | catalog/price-lists-and-rules | P1 | 🔲 todo |
e2e/vendor/catalog/suppliers.spec.ts | suppliers-list.png | catalog/suppliers | P1 | 🔲 todo |
Inventory
Section titled “Inventory”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/inventory/warehouses.spec.ts | warehouses-list.png, warehouse-detail.png | inventory/warehouses | P0 | 🔲 todo |
e2e/vendor/inventory/stocks.spec.ts | stocks-list.png | inventory/stocks | P0 | 🔲 todo |
e2e/vendor/inventory/adjustments.spec.ts | adjustment-form.png, adjustments-list.png | inventory/adjustments | P0 | 🔲 todo |
e2e/vendor/inventory/lots.spec.ts | lots-list.png | inventory/purchase-lots | P1 | 🔲 todo |
e2e/vendor/inventory/transfers.spec.ts | internal-transfer-form.png | inventory/internal-transfers | P1 | 🔲 todo |
Customers
Section titled “Customers”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/customers/customers-list.spec.ts | customers-list.png, customer-detail.png | customers/customers | P0 | 🔲 todo |
e2e/vendor/customers/categories.spec.ts | customer-categories-list.png | customers/customer-categories | P1 | 🔲 todo |
e2e/vendor/customers/memberships.spec.ts | memberships-list.png | customers/memberships | P1 | 🔲 todo |
Finance
Section titled “Finance”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/finance/transactions.spec.ts | transactions-list.png | finance/transactions | P0 | 🔲 todo |
e2e/vendor/finance/expenses.spec.ts | expenses-list.png | finance/expenses | P0 | 🔲 todo |
e2e/vendor/finance/refunds.spec.ts | refunds-list.png | finance/refunds | P0 | 🔲 todo |
e2e/vendor/finance/invoices.spec.ts | invoices-list.png | finance/invoices | P0 | 🔲 todo |
e2e/vendor/finance/receivables.spec.ts | receivables-list.png | finance/receivables | P0 | 🔲 todo |
e2e/vendor/finance/sales-overview.spec.ts | sales-overview.png | finance/sales-overview | P0 | 🔲 todo |
Employees
Section titled “Employees”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/employees/employees-list.spec.ts | employees-list.png, employee-detail.png | employees/employees | P0 | 🔲 todo |
e2e/vendor/employees/create-employee.spec.ts | create-employee-form.png | employees/create-employee | P0 | 🔲 todo |
e2e/vendor/employees/roles.spec.ts | roles-list.png | employees/roles | P0 | 🔲 todo |
Schedule
Section titled “Schedule”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/schedule/schedule-admin.spec.ts | schedule-admin.png | schedule/schedule-admin | P0 | 🔲 todo |
e2e/vendor/schedule/leaves-admin.spec.ts | leave-requests-list.png | schedule/leave-requests | P0 | 🔲 todo |
e2e/vendor/schedule/hr-dashboard.spec.ts | hr-dashboard.png | schedule/hr-dashboard | P0 | 🔲 todo |
Stores
Section titled “Stores”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/stores/stores-list.spec.ts | stores-list.png | stores/stores | P0 | 🔲 todo |
e2e/vendor/stores/store-configuration.spec.ts | store-configuration.png | stores/store-configuration | P0 | 🔲 todo |
Settings
Section titled “Settings”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/settings/hub.spec.ts | settings-hub.png | settings/settings-hub | P0 | 🔲 todo |
e2e/vendor/settings/devices.spec.ts | devices-settings.png | settings/devices | P0 | 🔲 todo |
e2e/vendor/settings/shift-templates.spec.ts | shift-templates.png | settings/shift-templates | P0 | 🔲 todo |
e2e/vendor/settings/checkout-lanes.spec.ts | checkout-lanes.png | settings/checkout-lanes | P0 | 🔲 todo |
Account
Section titled “Account”| Spec path | Screenshots | Doc page | Priority | Status |
|---|---|---|---|---|
e2e/vendor/account/profile.spec.ts | profile-page.png | account/profile | P0 | 🔲 todo |
e2e/vendor/account/notifications.spec.ts | notifications-feed.png | account/notifications-feed | P1 | 🔲 todo |
Summary counts
Section titled “Summary counts”| Category | Total needed | ✅ Done | 🔲 Todo | ⏭️ Skip |
|---|---|---|---|---|
| Screenshots | ~84 | 1 | ~82 | 1 |
| E2E specs | ~33 | 2 | ~31 | 0 |
| P0 specs | ~21 | 2 | ~19 | 0 |
| P1 specs | ~11 | 0 | ~11 | 0 |
| P2 / skip | ~1 | 0 | ~0 | ~1 |
Related
Section titled “Related”- E2E retail roadmap — phased P0/P1/P2 work packages
- System test cases index — TC-* scenario catalogue
- Vendor testing and screenshots index — legacy quality gate (deprecated; points here)
- Cashier docs screenshots checklist — equivalent for cashier guide