Complete checklist tracking every OmniOrders documentation page — see current status, planned content, and progress across all product areas.
---
title: Documentation Progress - Complete Checklist
description: Complete checklist tracking every OmniOrders documentation page — see current status, planned content, and progress across all product areas.
---
## OmniOV2 Documentation Progress
This page tracks the documentation status for all planned documentation pages. Each section shows the application view and all related documentation topics.
:::note[Documentation Focus]
We're prioritizing main application views first. Admin-specific views will be documented after the core user-facing features are complete.
:::
## 🚀 How to Create Documentation
To create documentation for any topic in this checklist, simply copy the command from the **"Command to Create"** column in the table and use it in Cursor chat.
For example, copy and paste commands like:
- `Create documentation for Orders Overview`
- `Create documentation for Profile Setup`
- `Create documentation for Inventory Management`
The command will automatically:
1. Research the feature in the codebase
2. Check translation files for exact UI terminology
3. Write user-friendly documentation
4. Update this checklist
5. Request your review
:::tip[Documentation Standards]
All documentation follows strict standards defined in `.cursor/rules/documentation-standards.mdc`:
- Only verified features from codebase
- Exact terminology from translation files
- Simple, 11th-grade language
- No AI jargon or buzzwords
:::
---
## 🔍 How to QA Review Documentation
Once documentation pages are created (AI Draft ✅), they need quality assurance review to ensure accuracy.
### QA Review Command
Use the QA review command in Cursor chat to systematically review any documentation page:
```
Review the Orders Overview documentation page
```
**What the command does**:
1. Guides you through the complete QA checklist
2. Helps verify UI terminology in translation files
3. Checks that features exist in codebase
4. Validates screenshots and formatting
5. Ensures writing quality standards are met
6. Updates the checklist after review
**Command Location**: `.cursor/commands/qa-review-docs.md`
### QA Review ClickUp Task
All 33 completed documentation pages are tracked in a comprehensive QA task:
**ClickUp Task**: [QA Review: OmniOrders Documentation - 33 Pages](https://app.clickup.com/t/86dyd7jhf)
**What's included**:
- Complete checklist of all 33 pages to review
- Step-by-step QA process for each page
- Common issues to look for
- Demo account credentials
- Resources and verification locations
- Success criteria
### QA Review Process
For each completed documentation page:
1. **Run the command**: "Review the [Page Name] documentation page"
2. **Login to demo**: https://dev4-omnio-v2.omniorders.com/
3. **Compare docs to app**: Verify all UI terms, steps, and features
4. **Check translation files**: Ensure exact terminology matches
5. **Review screenshots**: Confirm they're current and helpful
6. **Make corrections**: Minimal changes - only fix inaccuracies
7. **Update checklist**: Mark ✅ in "QA Review" column
:::caution[QA Review Guidelines]
- **Verify everything** - Compare docs to actual app functionality
- **Check translation files** - Use exact UI terminology from `/omniov2/src/lang/en/message.ts`
- **Minimal changes only** - Fix inaccuracies, don't rewrite
- **Update checklist** - Mark ✅ after completing review
:::
---
## How to Use This Checklist
**Documentation Workflow Stages:**
- ✅ **Complete** - Stage is done
- 🚧 **In Progress** - Currently working on this stage
- ❌ **Not Started** - Stage hasn't begun
---
## Getting Started
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| -------------------------------------------------------------- | -------- | --------- | ----- | -------- | ---------- | ------------------------------------------------------- |
| [**Account Access & Login**](/getting-started/account-access/) | ✅ | ✅ | ❌ | High | Auth pages | `Create documentation for Account Access & Login` |
| [**Profile Setup**](/getting-started/profile-setup/) | ✅ | ✅ | ❌ | High | `/profile` | `Create documentation for Profile Setup` |
| [**Navigation Basics**](/getting-started/navigation/) | ✅ | ✅ | ❌ | High | All views | `Create documentation for Navigation Basics` |
---
## Dashboard
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ------------------------------------------------ | -------- | --------- | ----- | -------- | ------------ | ---------------------------------------------- |
| [**Dashboard Overview**](/dashboard/overview/) | ✅ | ✅ | ❌ | High | `/dashboard` | `Create documentation for Dashboard Overview` |
| [**Metrics & Analytics**](/dashboard/analytics/) | ✅ | ✅ | ❌ | High | `/dashboard` | `Create documentation for Metrics & Analytics` |
---
## Orders
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ----------------------------------------------- | -------- | --------- | ----- | -------- | ------------------ | ------------------------------------------------------- |
| [**Orders Overview**](/orders/overview/) | ✅ | ✅ | ❌ | High | `/orders` | `Create documentation for Orders Overview` |
| [**Creating Orders**](/orders/creating/) | ✅ | ✅ | ❌ | High | `/orders/create` | `Create documentation for Creating Orders` |
| [**Editing Orders**](/orders/editing/) | ✅ | ✅ | ❌ | High | `/orders/edit/:id` | `Create documentation for Editing Orders` |
| [**Managing Orders**](/orders/managing/) | ✅ | ✅ | ❌ | High | `/orders` | `Create documentation for Managing Orders` |
| [**Order Status & Workflow**](/orders/status/) | ✅ | ✅ | ❌ | High | `/orders` | `Create documentation for Order Status & Workflow` |
| [**Returns & Refunds**](/orders/returns/) | ✅ | ✅ | ❌ | Medium | `/returns` | `Create documentation for Returns & Refunds` |
| [**Shipping & Fulfillment**](/orders/shipping/) | ✅ | ✅ | ❌ | High | `/shipping` | `Create documentation for Shipping & Fulfillment` |
---
## Inventory
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| --------------------------------------------------- | -------- | --------- | ----- | -------- | ------------------------------------------- | ------------------------------------------------------- |
| [**Inventory Overview**](/inventory/overview/) | ✅ | ✅ | ❌ | High | `/inventory` | `Create documentation for Inventory Overview` |
| [**Managing Inventory**](/inventory/managing/) | ✅ | ✅ | ❌ | High | `/products/new` & `/product/edit/:id` | `Create documentation for Managing Inventory` |
| [**Stock Management**](/inventory/stock/) | ✅ | ✅ | ❌ | High | `/inventory` | `Create documentation for Stock Management` |
| [**Fulfillment Locations**](/inventory/locations/) | ✅ | ✅ | ❌ | High | `/iLocs` | `Create documentation for Fulfillment Locations` |
| [**Stock Adjustments**](/inventory/adjustments/) | ✅ | ✅ | ❌ | High | `/inventory` | `Create documentation for Stock Adjustments` |
| [**Low Stock Alerts**](/inventory/alerts/) | ✅ | ✅ | ❌ | Medium | `/inventory` | `Create documentation for Low Stock Alerts` |
| [**Transfers**](/inventory/transfers/) | ✅ | ✅ | ❌ | High | `/transfers` | `Create documentation for Transfers` |
---
## Product Catalog
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ----------------------------------------------------- | -------- | --------- | ----- | -------- | ----------------------------------------- | ------------------------------------------------------- |
| [**Managing Products**](/products/managing/) | ✅ | ✅ | ❌ | High | `/products/new` & `/product/edit/:id` | `Create documentation for Managing Products` |
| [**Categories & Collections**](/products/categories/) | ✅ | ✅ | ❌ | Medium | `/products` | `Create documentation for Categories & Collections` |
---
## Purchase Orders
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ---------------------------------------------------------------------- | -------- | --------- | ----- | -------- | ---------------------------- | ------------------------------------------------------------ |
| [**Purchase Orders Overview**](/purchase-orders/overview/) | ✅ | ✅ | ❌ | High | `/purchase-orders` | `Create documentation for Purchase Orders Overview` |
| [**Creating Purchase Orders**](/purchase-orders/creating/) | ✅ | ✅ | ❌ | High | `/po-create` | `Create documentation for Creating Purchase Orders` |
| [**PO Shipments**](/purchase-orders/shipments/) | ✅ | ✅ | ❌ | Medium | `/purchase-order/shipments/:id/:shipmentId` | `Create documentation for PO Shipments` |
| [**Process PO Shipments**](/purchase-orders/process-shipments/) | ✅ | ✅ | ❌ | High | `/purchase-order/shipments/:id/:shipmentId` | `Create documentation for Process PO Shipments` |
---
## Returns
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ---------------------------------------------- | -------- | --------- | ----- | -------- | -------------- | -------------------------------------------------- |
| [**Returns Overview**](/returns/overview/) | ✅ | ✅ | ❌ | Medium | `/returns` | `Create documentation for Returns Overview` |
| [**Processing Returns**](/returns/processing/) | ✅ | ✅ | ❌ | Medium | `/returns` (no detail route — process via list actions) | `Create documentation for Processing Returns` |
---
## Customers
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ---------------------------------------------- | -------- | --------- | ----- | -------- | --------------------- | -------------------------------------------------- |
| [**Customers Overview**](/customers/overview/) | ✅ | ✅ | ❌ | Medium | `/customers` | `Create documentation for Customers Overview` |
| [**Managing Customers**](/customers/managing/) | ✅ | ✅ | ❌ | Medium | `/customer/:id` | `Create documentation for Managing Customers` |
---
## Suppliers
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ---------------------------------------------- | -------- | --------- | ----- | -------- | --------------------- | -------------------------------------------------- |
| [**Managing Suppliers**](/suppliers/managing/) | ✅ | ✅ | ❌ | Medium | `/suppliers` & `/supplier/:id` | `Create documentation for Managing Suppliers` |
---
## Transfers & Warehouses
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| -------------------------------------------------- | -------- | --------- | ----- | -------- | ------------------- | -------------------------------------------------- |
| [**Transfers Overview**](/transfers/overview/) | ✅ | ✅ | ❌ | Medium | `/transfers` | `Create documentation for Transfers Overview` |
| [**Creating Transfers**](/transfers/creating/) | ✅ | ✅ | ❌ | Medium | `/create-transfers` | `Create documentation for Creating Transfers` |
| [**Warehouses Management**](/warehouses/overview/) | ✅ | ✅ | ❌ | High | `/admin/warehouses` (admin-only) | `Create documentation for Warehouses Management` |
---
## Shipping & Packaging
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ---------------------------------------------- | -------- | --------- | ----- | -------- | ------------ | ------------------------------------------------------- |
| [**Shipping Management**](/shipping/overview/) | ❌ | ❌ | ❌ | Medium | `/shipping` | `Create documentation for Shipping Management` |
| [**Packaging Options**](/packaging/overview/) | ❌ | ❌ | ❌ | Low | `/packaging` | `Create documentation for Packaging Options` |
| [**Units of Measure (UOM)**](/uom/overview/) | ❌ | ❌ | ❌ | Low | `/uom` | `Create documentation for Units of Measure (UOM)` |
---
## Integrations
### General Integration Documentation
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| --------------------------------------------------------- | -------- | --------- | ----- | -------- | ----------------------- | ------------------------------------------------------------ |
| [**Integrations Overview**](/integrations/overview/) | ✅ | ❌ | ❌ | High | `/integrations` | `Create documentation for Integrations Overview` |
| [**Configuring Integrations**](/integrations/configuring/) | ❌ | ❌ | ❌ | High | `/services/config` | `Create documentation for Configuring Integrations` |
| [**Webhooks**](/integrations/webhooks/) | ❌ | ❌ | ❌ | Medium | `/integrations` | `Create documentation for Webhooks` |
| [**API Access**](/integrations/api/) | ❌ | ❌ | ❌ | Low | `/integrations` | `Create documentation for API Access` |
| [**Troubleshooting**](/integrations/troubleshooting/) | ❌ | ❌ | ❌ | Medium | `/integrations` | `Create documentation for Troubleshooting` |
### E-commerce Platforms
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Status | Command to Create |
| ----------------------------------------------- | -------- | --------- | ----- | -------- | --------------- | ------ | ---------------------------------------------------- |
| [**Shopify**](/integrations/shopify/) | ✅ | ✅ | ✅ | High | `/integrations` | ✅ Available | `Create documentation for Shopify` |
| [**WooCommerce**](/integrations/woocommerce/) | ✅ | ✅ | ❌ | High | `/integrations` | 🔵 Beta | `Create documentation for WooCommerce` |
| [**BigCommerce**](/integrations/bigcommerce/) | ✅ | ✅ | ❌ | High | `/integrations` | ✅ Available | `Create documentation for BigCommerce` |
| [**OMNIO Local Channel**](/integrations/omnio/) | ✅ | ✅ | ❌ | Medium | `/integrations` | ✅ Available | `Create documentation for OMNIO Local Channel` |
### Marketplaces
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Status | Command to Create |
| -------------------------------------------------- | -------- | --------- | ----- | -------- | --------------- | ------ | ---------------------------------------------------- |
| [**Amazon Seller Central**](/integrations/amazon-seller-central/) | ✅ | ✅ | ❌ | High | `/integrations` | 🔵 Beta | `Create documentation for Amazon Seller Central` |
| [**eBay**](/integrations/ebay/) | ✅ | ✅ | ❌ | High | `/integrations` | ✅ Available | `Create documentation for eBay` |
| [**Walmart Marketplace**](/integrations/walmart/) | ✅ | ✅ | ❌ | High | `/integrations` | 🔵 Beta | `Create documentation for Walmart Marketplace` |
| [**Etsy**](/integrations/etsy/) | ✅ | ✅ | ❌ | Medium | `/integrations` | 🔵 Beta | `Create documentation for Etsy` |
| [**Mercado Libre**](/integrations/mercado-libre/) | ❌ | ❌ | ❌ | Medium | `/integrations` | ✅ Available | `Create documentation for Mercado Libre` |
| [**Falabella**](/integrations/falabella/) | ✅ | ✅ | ❌ | Medium | `/integrations` | 🔵 Beta | `Create documentation for Falabella` |
| [**Multivende**](/integrations/multivende/) | ✅ | ✅ | ❌ | Medium | `/integrations` | 🔵 Beta | `Create documentation for Multivende` |
| [**TikTok Shop**](/integrations/tiktok/) | ✅ | ✅ | ❌ | Medium | `/integrations` | 🔜 Coming Soon | `Create documentation for TikTok Shop` |
### 3PL & Fulfillment
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Status | Command to Create |
| --------------------------------------- | -------- | --------- | ----- | -------- | --------------- | ------ | ---------------------------------------------------- |
| [**Proximity**](/integrations/proximity/) | ✅ | ✅ | ❌ | Low | `/integrations` | ✅ Available | `Create documentation for Proximity` |
### Business Tools & Accounting
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Status | Command to Create |
| ------------------------------------------- | -------- | --------- | ----- | -------- | --------------- | ------ | ---------------------------------------------------- |
| [**QuickBooks**](/integrations/quickbooks/) | ❌ | ❌ | ❌ | Medium | `/integrations` | ✅ Available | `Create documentation for QuickBooks` |
### EDI & B2B Integrations
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Status | Command to Create |
| ------------------------------------------------------ | -------- | --------- | ----- | -------- | ----------------------- | ------ | ---------------------------------------------------- |
| [**CommerceHub**](/integrations/commercehub/) | ✅ | ✅ | ❌ | Medium | `/services/commercehub` | ✅ Available | `Create documentation for CommerceHub` |
| [**EDI OpenText**](/integrations/edi/) | ✅ | ✅ | ❌ | Medium | `/services/edi` | ✅ Available | `Create documentation for EDI OpenText` |
| [**SPS Commerce**](/integrations/sps-commerce/) | ✅ | ✅ | ❌ | Medium | `/integrations` | ✅ Available | `Create documentation for SPS Commerce` |
| [**DiamondGraphics**](/integrations/diamond-graphics/) | ❌ | ❌ | ❌ | Low | `/integrations` | ✅ Available | `Create documentation for DiamondGraphics` |
### Communication & Utilities
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Status | Command to Create |
| -------------------------------------------------------------------- | -------- | --------- | ----- | -------- | ------------------------- | ------ | --------------------------------------------------------- |
| [**Email by SMTP**](/integrations/email-smtp/) | ✅ | ✅ | ❌ | Low | `/services/email-account` | ✅ Available | `Create documentation for Email by SMTP` |
| [**Request an Integration**](/integrations/request-integration/) | ✅ | ✅ | ❌ | Low | `/integrations` | 🔧 Custom | `Create documentation for Request an Integration` |
---
## Automation
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ----------------------------------------------------- | -------- | --------- | ----- | -------- | --------------- | ------------------------------------------------------- |
| [**Automation Overview**](/automation/overview/) | ✅ | ✅ | ❌ | High | `/rules` | `Create documentation for Automation Overview` |
| [**Creating & Managing Rules**](/automation/managing-rules/) | ✅ | ✅ | ❌ | High | `/rules` | `Create documentation for Creating & Managing Rules` |
---
## Reports & Analytics
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ------------------------------------------------ | -------- | --------- | ----- | -------- | -------------- | ------------------------------------------------------- |
| [**Reports Overview**](/reports/overview/) | ❌ | ❌ | ❌ | Medium | Multiple views | `Create documentation for Reports Overview` |
| [**Sales Reports**](/reports/sales/) | ❌ | ❌ | ❌ | Medium | Dashboard | `Create documentation for Sales Reports` |
| [**Inventory Reports**](/reports/inventory/) | ❌ | ❌ | ❌ | Medium | `/inventory` | `Create documentation for Inventory Reports` |
| [**Fulfillment Reports**](/reports/fulfillment/) | ❌ | ❌ | ❌ | Medium | `/orders` | `Create documentation for Fulfillment Reports` |
| [**Custom Reports**](/reports/custom/) | ❌ | ❌ | ❌ | Low | Multiple views | `Create documentation for Custom Reports` |
| [**Exporting Data**](/reports/exporting/) | ❌ | ❌ | ❌ | Medium | All views | `Create documentation for Exporting Data` |
---
## Team & Settings
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ------------------------------------------------ | -------- | --------- | ----- | -------- | ------------------------------- | ------------------------------------------------------- |
| [**Profile Management**](/profile/overview/) | ❌ | ❌ | ❌ | Medium | `/profile` | `Create documentation for Profile Management` |
| [**Settings Overview**](/settings/overview/) | ❌ | ❌ | ❌ | High | `/settings` | `Create documentation for Settings Overview` |
| [**User Management**](/settings/users/) | ❌ | ❌ | ❌ | Medium | `/members` | `Create documentation for User Management` |
| [**Roles & Permissions**](/settings/roles/) | ❌ | ❌ | ❌ | Medium | `/roles` & `/roles/create-edit` | `Create documentation for Roles & Permissions` |
| [**Company Profile**](/settings/company/) | ❌ | ❌ | ❌ | Medium | `/settings` | `Create documentation for Company Profile` |
| [**Billing & Subscription**](/settings/billing/) | ❌ | ❌ | ❌ | Medium | `/settings` | `Create documentation for Billing & Subscription` |
| [**Preferences**](/settings/preferences/) | ❌ | ❌ | ❌ | Low | `/settings` | `Create documentation for Preferences` |
| [**Security & Privacy**](/settings/security/) | ❌ | ❌ | ❌ | Medium | `/settings` | `Create documentation for Security & Privacy` |
---
## Support & Resources
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ------------------------------------------ | -------- | --------- | ----- | -------- | -------- | -------------------------------------------------- |
| [**Getting Help**](/support/getting-help/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Getting Help` |
| [**Contact Support**](/support/contact/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Contact Support` |
| [**FAQ**](/support/faq/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for FAQ` |
| [**Video Tutorials**](/support/videos/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Video Tutorials` |
| [**Release Notes**](/support/releases/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Release Notes` |
| [**Status & Uptime**](/support/status/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Status & Uptime` |
| [**Send Feedback**](/support/feedback/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Send Feedback` |
---
## Advanced Topics
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ------------------------------------------------------ | -------- | --------- | ----- | -------- | -------- | ------------------------------------------------------- |
| [**API Documentation**](/advanced/api/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for API Documentation` |
| [**Developer Tools**](/advanced/developer-tools/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Developer Tools` |
| [**Custom Scripts**](/advanced/scripts/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Custom Scripts` |
| [**Performance Optimization**](/advanced/performance/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Performance Optimization` |
| [**Multi-User Setup**](/advanced/multi-tenant/) | ❌ | ❌ | ❌ | Low | N/A | `Create documentation for Multi-User Setup` |
---
## System & Error Views
| Documentation Page | AI Draft | QA Review | Ready | Priority | App View | Command to Create |
| ---------------------------------------------------------- | -------- | --------- | ----- | -------- | --------------- | ------------------------------------------------------- |
| [**Feed History**](/system/feed-history/) | ❌ | ❌ | ❌ | Low | `/feed-history` | `Create documentation for Feed History` |
| [**Error Management**](/system/errors/) | ❌ | ❌ | ❌ | Medium | `/errors` | `Create documentation for Error Management` |
| [**CSV Upload**](/system/csv-upload/) | ❌ | ❌ | ❌ | Low | `/upload-csv` | `Create documentation for CSV Upload` |
| [**Registration Process**](/getting-started/registration/) | ❌ | ❌ | ❌ | Medium | `/register` | `Create documentation for Registration Process` |
| [**Return Share Portal**](/returns/share-portal/) | ❌ | ❌ | ❌ | Low | Public returns | `Create documentation for Return Share Portal` |
---
## Documentation Progress Summary
### Overall Statistics
```
Total Documentation Pages: 93 (End-User Views Only)
(Note: 27 pages were consolidated, 9 admin pages removed - see Recent Changes below)
AI Draft Progress:
✅ AI Draft Complete: 35 pages (37.6%)
❌ AI Draft Not Started: 58 pages (62.4%)
Overall Progress:
✅ QA Reviewed & Ready: 1 page (1.1%)
🚧 Awaiting QA Review: 34 pages (36.6%)
❌ Not Started: 58 pages (62.4%)
```
### Recent Changes
- **QA Review Workflow Established** (Jan 12, 2025): Created comprehensive QA review system for all completed documentation
- **ClickUp Task Created**: [QA Review: OmniOrders Documentation - 33 Pages](https://app.clickup.com/t/86dyd7jhf)
- **Command Created**: `.cursor/commands/qa-review-docs.md` - Systematic review guide with full checklist
- **Checklist Updated**: Added "How to QA Review Documentation" section with process, command usage, and guidelines
- **What's Included**:
- Complete checklist of all 33 pages requiring QA review
- Step-by-step QA process (verify UI terms, check translations, validate screenshots)
- Common issues to look for (inaccurate terminology, missing steps, outdated screenshots)
- Demo account credentials and resource locations
- Success criteria and quality standards
- **Next Phase**: QA person can now systematically review all completed documentation pages for accuracy
- **Impact**: Established production-ready quality assurance workflow for documentation
- **Process PO Shipments Documentation Added** (Jan 12, 2025): Created comprehensive receiving workflow guide for local fulfillment locations
- **Rationale**: Users need guidance on manually receiving inventory at local locations versus automatic receiving at external warehouses
- **Content**: Step-by-step receiving workflow, quantity tracking, partial deliveries, status management, troubleshooting, and best practices
- **Location**: Purchase Orders section (new 4th page)
- **Updates**: Also updated PO Overview and PO Shipments docs to clarify local vs. external warehouse receiving workflows
- **Impact**: Total pages increased from 92 to 93, AI Draft Complete increased from 32 to 33
- **Product Catalog Cleaned** (Jan 11, 2025): Removed duplicate "Purchase Orders" entry from Product Catalog section
- **Rationale**: Purchase Orders has its own dedicated section with 3 pages (Overview, Creating, Shipments)
- **Impact**: Product Catalog now has 2 pages (Managing Products, Categories & Collections)
- **Result**: Cleaner organization, total pages reduced from 93 to 92 (one duplicate removed)
- **Admin Views Removed** (Jan 10, 2025): Removed all admin-only views from documentation scope
- **Rationale**: Documentation focuses exclusively on end-user views, not system administrator functions
- **Removed**: 9 admin pages (Admin Dashboard, Companies Management, Company Configuration, Admin Users, Warehouses Admin, Admin Services, Shipping Services Admin, App Services Admin, Mapper Templates)
- **Impact**: Total pages reduced from 101 to 92, all low-priority pages
- **Checklist Simplified** (Jan 10, 2025): Removed all strikethrough consolidated items for better readability
- **Removed from display**: 20+ consolidated items that were making tables cluttered
- **Still tracked**: All consolidation details preserved in "Recent Changes" section below
- **Result**: Cleaner, easier-to-scan checklist showing only active documentation pages
- **Integrations List Updated to Match Production** (Jan 10, 2025): Verified actual integrations available in production and added status badges
- ✅ **Available**: Shopify, BigCommerce, OMNIO, eBay, Mercado Libre, Proximity, QuickBooks, CommerceHub, EDI OpenText, SPS Commerce, DiamondGraphics, Email by SMTP
- 🔵 **Beta**: WooCommerce, Amazon Seller Central, Walmart, Etsy, Falabella, Multivende
- 🔧 **Custom**: Request a Custom Integration
- ❌ **Removed**: Magento, USPS, UPS, FedEx, DHL, Xero (not in current production)
- **Category Updated**: "Shipping & Fulfillment" renamed to "3PL & Fulfillment" to accurately reflect Proximity focus
- **Managing Suppliers Documentation Created** (Jan 10, 2025): Complete guide for managing suppliers, including creation, editing, addresses, contacts, groups, and lead time tracking
- **Suppliers Overview Consolidated** (Jan 10, 2025): "Suppliers Overview" merged into "Managing Suppliers" - list view is a simple table covered in managing documentation
- **Managing Products Documentation Created** (Jan 10, 2025): Comprehensive guide covering product creation, editing, single/multi-SKU configuration, organization, images, and troubleshooting
- **Catalog Overview Consolidated** (Jan 10, 2025): "Catalog Overview" merged into "Inventory Overview" - verified `/products` route does not exist in application, `/inventory` serves as the product catalog
- **Major Documentation Consolidation** (Nov 5, 2025): Reduced documentation from 120 to 105 pages by consolidating related features
- **Product Catalog**: Consolidated Variants, Options, Pricing & Costs, and Images into "Managing Products" (4 pages → 1)
- **Integrations**: Consolidated Service Connections, Configuration, Mapping, Rules, and Settings into "Configuring Integrations" (5 pages → 1)
- **Automation**: Consolidated Creating Rules, Order Routing, Email Notifications, Auto-fulfillment, Scheduled Tasks, and Custom Workflows into "Creating & Managing Rules" (6 pages → 1)
- **Customer/Supplier Groups**: Consolidated Groups pages into parent "Managing" pages (2 pages → 0)
- **Inventory History**: Consolidated into "Stock Management" (1 page → 0)
- **Rationale**: All consolidated features are accessed through the same interface (tabs, dialogs, or sections within parent page), not separate routes
- **Orders Documentation Consolidated** (Nov 5, 2025): "Bulk Operations" and "Order Tags & Notes" merged into existing pages
### Priority Breakdown
- **High Priority**: 35 pages (13 consolidated)
- **Medium Priority**: 46 pages (9 consolidated)
- **Low Priority**: 11 pages (4 consolidated, 9 admin removed)
---
## Documentation Guidelines
Each documentation page should include:
### 📄 Comprehensive Documentation
- **Screenshots**: Actual interface with annotations
- **Field Descriptions**: What each field does and when to use it
- **Workflows**: Step-by-step instructions for common tasks
- **Best Practices**: Tips and recommended approaches
- **Use Cases**: Real-world examples
- **Troubleshooting**: Common issues and solutions
- **Related Features**: Links to connected functionality
### App View Coverage
The "App View" column shows which application routes each documentation page covers. Some pages cover multiple views (e.g., "Managing Products" covers both create and edit views).
---
## Contributing
**To update this checklist:**
1. Mark workflow stages (AI Draft, QA Review, Ready) as you progress
2. Add links to completed documentation
3. Note any blockers or dependencies
4. Update priority if requirements change
**Last Updated**: January 12, 2025 - QA Review Workflow Established