Bỏ qua để đến nội dung

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.

VersionDate (UTC)Summary
1.0.02026-09-24Initial: P0/P1/P2 specs + screenshots matrix for all vendor guide pages

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 in apps/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.

apps/docs/public/screenshots/vendor/<area>/<page>-<variant>.png
  • area = getting-started, sales, catalog, inventory, customers, finance, employees, schedule, stores, settings, account
  • page = slug của page (e.g. orders-list, create-order)
  • variant = tùy chọn (e.g. empty, with-data, modal)
apps/vendor-web/e2e/vendor/<area>/<flow>.spec.ts
  • area = cùng area như screenshots
  • flow = mô tả ngắn gọn (e.g. orders-list.spec.ts, create-order.spec.ts)

All vendor E2E specs reuse helpers from apps/vendor-web/e2e/fixtures/ (to be created in Phase 0):

apps/vendor-web/e2e/fixtures/vendor.fixture.ts
export const vendorFixtures = {
loginAsOwner: async ({ page }) => { /* ... */ },
loginAsEmployee: async ({ page }, options?: { module?: string }) => { /* ... */ },
selectStore: async ({ page }, storeId?: string) => { /* ... */ },
goto: async ({ page }, path: string) => { /* ... */ },
};

PriorityMeaningRelease gate
P0Revenue-critical: wrong behavior loses money, stock, or trustRequired before “vendor E2E ready”
P1Important operationsRecommended before major releases
P2Config / lower-trafficBacklog

Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/getting-started/logingetting-started/login.pngauthP0✅ done (renamed from vendor-login-sign-in.png)
guides/vendor/getting-started/auth-accountgetting-started/login.png, getting-started/forgot-password.png, getting-started/verify-otp.png, getting-started/reset-password.png, account/profile-page.pngauthP0🔲 todo (docs + e2e spec staged; run npm run test:e2e:auth-account:docs in apps/vendor-web)
guides/vendor/getting-started/first-storegetting-started/first-store-wizard.pngformP0🔲 todo
guides/vendor/getting-started/dashboard-tourgetting-started/dashboard-home.png, getting-started/sidebar-navigation.pngpageP0🔲 todo
guides/vendor/getting-started/roles-and-modulesgetting-started/role-matrix-overview.pngtableP0🔲 todo
guides/vendor/getting-started/role-matrixgetting-started/role-matrix-full.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/sales/orderssales/orders-list.png, sales/order-detail.pnglist + detailP0🔲 todo
guides/vendor/sales/create-ordersales/create-order-form.pngformP0🔲 todo
guides/vendor/sales/wholesalesales/wholesale-orders-list.pnglistP0🔲 todo
guides/vendor/sales/create-wholesalesales/create-wholesale-form.pngformP0🔲 todo
guides/vendor/sales/returns-and-refundssales/returns-list.png, sales/refund-approval-form.pnglist + modalP0🔲 todo
guides/vendor/sales/deliveriessales/deliveries-list.pnglistP1🔲 todo
guides/vendor/sales/work-shiftssales/work-shifts-list.png, sales/open-shift-dialog.png, sales/close-shift-dialog.pnglist + modalP0🔲 todo
guides/vendor/sales/pos-workspacesales/pos-workspace.pngpageP0🔲 todo
guides/vendor/sales/role-matrixsales/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/catalog/productscatalog/products-list.png, catalog/product-detail.pnglist + detailP0🔲 todo
guides/vendor/catalog/create-and-edit-productcatalog/create-product-form.png, catalog/edit-product-form.pngformP0🔲 todo
guides/vendor/catalog/categoriescatalog/product-categories-list.pnglistP1🔲 todo
guides/vendor/catalog/units-attributes-tags-brandscatalog/units-list.pnglistP1🔲 todo
guides/vendor/catalog/store-taxescatalog/store-taxes-list.pnglistP1🔲 todo
guides/vendor/catalog/supplierscatalog/suppliers-list.png, catalog/supplier-detail.pnglist + detailP1🔲 todo
guides/vendor/catalog/smart-importcatalog/smart-import-form.pngformP1🔲 todo
guides/vendor/catalog/price-lists-and-rulescatalog/price-lists-list.png, catalog/price-list-detail.pnglist + detailP1🔲 todo
guides/vendor/catalog/price-approvalscatalog/price-approvals-list.pnglistP1🔲 todo
guides/vendor/catalog/gallerycatalog/gallery-page.pngpageP1🔲 todo
guides/vendor/catalog/marketing-bannerscatalog/banners-list.pnglistP1🔲 todo
guides/vendor/catalog/addons—placeholderP2⏭️ skip
guides/vendor/catalog/role-matrixcatalog/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/inventory/warehousesinventory/warehouses-list.png, inventory/warehouse-detail.pnglist + detailP0🔲 todo
guides/vendor/inventory/stocksinventory/stocks-list.pnglistP0🔲 todo
guides/vendor/inventory/purchase-lotsinventory/lots-list.png, inventory/lot-detail.pnglist + detailP1🔲 todo
guides/vendor/inventory/adjustmentsinventory/adjustment-form.png, inventory/adjustments-list.pngform + listP0🔲 todo
guides/vendor/inventory/inter-store-borrowinventory/inter-store-borrow-form.pngformP1🔲 todo
guides/vendor/inventory/internal-transfersinventory/internal-transfer-form.pngformP1🔲 todo
guides/vendor/inventory/role-matrixinventory/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/customers/customerscustomers/customers-list.png, customers/customer-detail.pnglist + detailP0🔲 todo
guides/vendor/customers/customer-categoriescustomers/customer-categories-list.pnglistP1🔲 todo
guides/vendor/customers/membershipscustomers/memberships-list.pnglistP1🔲 todo
guides/vendor/customers/discountscustomers/discounts-list.pnglistP1🔲 todo
guides/vendor/customers/role-matrixcustomers/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/finance/transactionsfinance/transactions-list.pnglistP0🔲 todo
guides/vendor/finance/expensesfinance/expenses-list.pnglistP0🔲 todo
guides/vendor/finance/refundsfinance/refunds-list.pnglistP0🔲 todo
guides/vendor/finance/invoicesfinance/invoices-list.pnglistP0🔲 todo
guides/vendor/finance/receivablesfinance/receivables-list.pnglistP0🔲 todo
guides/vendor/finance/sales-overviewfinance/sales-overview.pngreportP0🔲 todo
guides/vendor/finance/sales-reportfinance/sales-report.pngreportP0🔲 todo
guides/vendor/finance/reports-hubfinance/reports-hub.pngpageP0🔲 todo
guides/vendor/finance/taxes-reportfinance/taxes-report.pngreportP1🔲 todo
guides/vendor/finance/closeoutfinance/closeout-list.pnglistP1🔲 todo
guides/vendor/finance/role-matrixfinance/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/employees/employeesemployees/employees-list.png, employees/employee-detail.pnglist + detailP0🔲 todo
guides/vendor/employees/create-employeeemployees/create-employee-form.pngformP0🔲 todo
guides/vendor/employees/rolesemployees/roles-list.pnglistP0🔲 todo
guides/vendor/employees/managersemployees/managers-list.pnglistP1🔲 todo
guides/vendor/employees/employee-tipsemployees/employee-tips.pngpageP1🔲 todo
guides/vendor/employees/role-matrixemployees/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/schedule/schedule-adminschedule/schedule-admin.pngpageP0🔲 todo
guides/vendor/schedule/my-scheduleschedule/my-schedule.pngpageP1🔲 todo
guides/vendor/schedule/attendance-detailschedule/attendance-detail.pngdetailP0🔲 todo
guides/vendor/schedule/leave-requestsschedule/leave-requests-list.pnglistP0🔲 todo
guides/vendor/schedule/my-leavesschedule/my-leaves.pngpageP1🔲 todo
guides/vendor/schedule/leave-historyschedule/leave-history.pngpageP1🔲 todo
guides/vendor/schedule/hr-dashboardschedule/hr-dashboard.pngpageP0🔲 todo
guides/vendor/schedule/timesheet-reportschedule/timesheet-report.pngreportP0🔲 todo
guides/vendor/schedule/hr-settingsschedule/hr-settings.pngpageP1🔲 todo
guides/vendor/schedule/role-matrixschedule/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/stores/storesstores/stores-list.pnglistP0🔲 todo
guides/vendor/stores/create-storestores/create-store-form.pngformP0🔲 todo
guides/vendor/stores/store-configurationstores/store-configuration.pngpageP0🔲 todo
guides/vendor/stores/availabilitystores/availability-template.pngpageP1🔲 todo
guides/vendor/stores/role-matrixstores/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/settings/settings-hubsettings/settings-hub.pngpageP0🔲 todo
guides/vendor/settings/generalsettings/general-settings.pngpageP1🔲 todo
guides/vendor/settings/notificationssettings/notifications-settings.pngpageP1🔲 todo
guides/vendor/settings/devicessettings/devices-settings.pngpageP0🔲 todo
guides/vendor/settings/receipt-templatesettings/receipt-template.pngpageP1🔲 todo
guides/vendor/settings/invoice-templatesettings/invoice-template.pngpageP1🔲 todo
guides/vendor/settings/smtpsettings/smtp-settings.pngpageP1🔲 todo
guides/vendor/settings/shift-templatessettings/shift-templates.pngpageP0🔲 todo
guides/vendor/settings/checkout-lanessettings/checkout-lanes.pngpageP0🔲 todo
guides/vendor/settings/terminalssettings/terminals-list.pnglistP0🔲 todo
guides/vendor/settings/hardware-labs—internalP2⏭️ skip
guides/vendor/settings/role-matrixsettings/role-matrix.pngtableP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/account/profileaccount/profile-page.pngpageP0🔲 todo
guides/vendor/account/notifications-feedaccount/notifications-feed.pngpageP0🔲 todo
guides/vendor/account/billingaccount/billing-page.pngpageP0🔲 todo
guides/vendor/account/support-ticketsaccount/support-tickets.pngpageP0🔲 todo
Doc pageScreenshot(s) neededTypePriorityStatus
guides/vendor/admin-only/system-pages—owner-onlyP2⏭️ skip
guides/vendor/admin-only/platform-membership—owner-onlyP2⏭️ skip

Spec pathScreenshotsDoc pagePriorityStatus
e2e/login.spec.ts— (already exists)—P0✅ done
e2e/vendor/getting-started/auth-account.spec.ts— (functional)getting-started/auth-accountP0✅ done (staged — see npm run test:e2e:auth-account)
e2e/vendor/getting-started/docs-auth-screenshots.spec.tsforgot-password.png, verify-otp.png, reset-password.pnggetting-started/auth-accountP0✅ done (staged — see npm run test:e2e:auth-account:docs)
e2e/vendor/getting-started/dashboard-home.spec.tsdashboard-home.png, sidebar-navigation.pnggetting-started/dashboard-tourP0🔲 todo
e2e/vendor/getting-started/navigation.spec.tssidebar-navigation.pnggetting-started/dashboard-tourP1🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/sales/orders-list.spec.tsorders-list.png, order-detail.pngsales/ordersP0🔲 todo
e2e/vendor/sales/create-order.spec.tscreate-order-form.pngsales/create-orderP0🔲 todo
e2e/vendor/sales/wholesale.spec.tswholesale-orders-list.png, create-wholesale-form.pngsales/wholesale, sales/create-wholesaleP0🔲 todo
e2e/vendor/sales/returns.spec.tsreturns-list.png, refund-approval-form.pngsales/returns-and-refundsP0🔲 todo
e2e/vendor/sales/deliveries.spec.tsdeliveries-list.pngsales/deliveriesP1🔲 todo
e2e/vendor/sales/work-shifts.spec.tswork-shifts-list.png, open-shift-dialog.png, close-shift-dialog.pngsales/work-shiftsP0🔲 todo
e2e/vendor/sales/pos-workspace.spec.tspos-workspace.pngsales/pos-workspaceP0🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/catalog/products-list.spec.tsproducts-list.png, product-detail.pngcatalog/productsP0🔲 todo
e2e/vendor/catalog/create-product.spec.tscreate-product-form.pngcatalog/create-and-edit-productP0🔲 todo
e2e/vendor/catalog/categories.spec.tsproduct-categories-list.pngcatalog/categoriesP1🔲 todo
e2e/vendor/catalog/price-lists.spec.tsprice-lists-list.png, price-list-detail.pngcatalog/price-lists-and-rulesP1🔲 todo
e2e/vendor/catalog/suppliers.spec.tssuppliers-list.pngcatalog/suppliersP1🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/inventory/warehouses.spec.tswarehouses-list.png, warehouse-detail.pnginventory/warehousesP0🔲 todo
e2e/vendor/inventory/stocks.spec.tsstocks-list.pnginventory/stocksP0🔲 todo
e2e/vendor/inventory/adjustments.spec.tsadjustment-form.png, adjustments-list.pnginventory/adjustmentsP0🔲 todo
e2e/vendor/inventory/lots.spec.tslots-list.pnginventory/purchase-lotsP1🔲 todo
e2e/vendor/inventory/transfers.spec.tsinternal-transfer-form.pnginventory/internal-transfersP1🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/customers/customers-list.spec.tscustomers-list.png, customer-detail.pngcustomers/customersP0🔲 todo
e2e/vendor/customers/categories.spec.tscustomer-categories-list.pngcustomers/customer-categoriesP1🔲 todo
e2e/vendor/customers/memberships.spec.tsmemberships-list.pngcustomers/membershipsP1🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/finance/transactions.spec.tstransactions-list.pngfinance/transactionsP0🔲 todo
e2e/vendor/finance/expenses.spec.tsexpenses-list.pngfinance/expensesP0🔲 todo
e2e/vendor/finance/refunds.spec.tsrefunds-list.pngfinance/refundsP0🔲 todo
e2e/vendor/finance/invoices.spec.tsinvoices-list.pngfinance/invoicesP0🔲 todo
e2e/vendor/finance/receivables.spec.tsreceivables-list.pngfinance/receivablesP0🔲 todo
e2e/vendor/finance/sales-overview.spec.tssales-overview.pngfinance/sales-overviewP0🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/employees/employees-list.spec.tsemployees-list.png, employee-detail.pngemployees/employeesP0🔲 todo
e2e/vendor/employees/create-employee.spec.tscreate-employee-form.pngemployees/create-employeeP0🔲 todo
e2e/vendor/employees/roles.spec.tsroles-list.pngemployees/rolesP0🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/schedule/schedule-admin.spec.tsschedule-admin.pngschedule/schedule-adminP0🔲 todo
e2e/vendor/schedule/leaves-admin.spec.tsleave-requests-list.pngschedule/leave-requestsP0🔲 todo
e2e/vendor/schedule/hr-dashboard.spec.tshr-dashboard.pngschedule/hr-dashboardP0🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/stores/stores-list.spec.tsstores-list.pngstores/storesP0🔲 todo
e2e/vendor/stores/store-configuration.spec.tsstore-configuration.pngstores/store-configurationP0🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/settings/hub.spec.tssettings-hub.pngsettings/settings-hubP0🔲 todo
e2e/vendor/settings/devices.spec.tsdevices-settings.pngsettings/devicesP0🔲 todo
e2e/vendor/settings/shift-templates.spec.tsshift-templates.pngsettings/shift-templatesP0🔲 todo
e2e/vendor/settings/checkout-lanes.spec.tscheckout-lanes.pngsettings/checkout-lanesP0🔲 todo
Spec pathScreenshotsDoc pagePriorityStatus
e2e/vendor/account/profile.spec.tsprofile-page.pngaccount/profileP0🔲 todo
e2e/vendor/account/notifications.spec.tsnotifications-feed.pngaccount/notifications-feedP1🔲 todo

CategoryTotal needed✅ Done🔲 Todo⏭️ Skip
Screenshots~841~821
E2E specs~332~310
P0 specs~212~190
P1 specs~110~110
P2 / skip~10~0~1