ShipEdge.core Documentation Progress - Complete Checklist

ShipEdge.core Documentation Progress

This page tracks the documentation status for all planned ShipEdge.core documentation pages. Each section shows the application view and all related documentation topics.

ShipEdge Core Documentation

This is the complete documentation checklist for ShipEdge.core covering both OMS (Order Management System) and WMS (Warehouse Management System) features.

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 type in Cursor chat:

/create-documentation

Then specify which topic you want to create. For example:

• “Create documentation for Orders Overview”
• “Create documentation for Warehouse Bins Management”
• “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

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 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
Account Access & Login	✅	✅	❌	High	Auth pages
Profile Setup	✅	✅	❌	High	/changepass.php
Navigation Basics	✅	✅	❌	High	All views
System Overview	✅	✅	❌	High	System architecture
User Types & Permissions	✅	✅	❌	High	/preferencesSettings.php
Wall Communication	✅	✅	❌	Medium	/vpb_wall.php

---

OMS (Order Management System)

Orders Management

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Orders Overview	✅	✅	❌	High	/orders.php
Creating Orders	✅	✅	❌	High	/up-order.php
Editing Orders	✅	✅	❌	High	/All_Ordersedit.php
Managing Orders	✅	✅	❌	High	/All_Orderslist.php
Order Status & Workflow	✅	✅	❌	High	All order views
Uploading Orders (CSV)	✅	✅	❌	High	/UploadOrdersFileadd_new.php
Upload Orders Configuration	✅	✅	❌	Medium	/configUploadOrders.php
Shipped Orders	✅	✅	❌	High	/shipped_orders.php
Order Alerts	✅	✅	❌	Medium	/orders.php
Backorders	✅	✅	❌	Medium	/orders.php
Address Book	✅	✅	❌	Medium	/addressbook.php

---

Inventory (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Catalog Overview	✅	✅	❌	High	/catalog_list.php
Product Management	✅	✅	❌	High	/Inventory_Productslist.php
Creating Products	✅	✅	❌	High	/Inventory_Productsadd.php
Product Classes	✅	✅	❌	High	/Class_Sellerlist.php
Product Attributes	✅	✅	❌	Medium	/AttributosProductslist.php
Metadata Management	✅	✅	❌	Medium	/attributes.php
Suppliers	✅	✅	❌	High	/Supplier_Sellerlist.php
SKU Management	✅	✅	❌	High	Various product views
SKU Substitutions	✅	✅	❌	High	/item_subtitute_manager.php
Stagnated Inventory	✅	✅	❌	Low	/stagnated.php
Distribution Centers	✅	✅	❌	High	/distributionCenters.php
Product Families (SynSets™)	✅	✅	❌	Medium	/FamilieslistSeller.php
Active SKUs (Alternative SKUs)	✅	✅	❌	Medium	/sku_atives.php

---

Replenishment (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Replenishment Overview	✅	✅	❌	High	/New_Requestlist.php
Creating Replenishment Requests	✅	✅	❌	High	/New_Requestadd.php
Bulk Upload Inventory	✅	✅	❌	High	/MasterUploadInventoryadd.php
Archived Replenishments	✅	✅	❌	Medium	/replenishment_archivedlist.php
ETA Management	✅	❌	❌	Medium	/etalist.php

---

Returns & Exchanges (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Returns Overview	✅	✅	❌	High	/Return_order_sellerlistlist.php
Processing Returns	✅	✅	❌	High	Return views
Exchanges (RMA)	✅	✅	❌	Medium	/All_Orders_rs_list.php
Archived Returns	✅	✅	❌	Medium	/return_archivedlist.php
Restocking	✅	✅	❌	Medium	/generate_restockingadd.php
Return Label Status	✅	✅	❌	Medium	/return_label_status.php

---

Integrations (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Integrations Overview	✅	✅	❌	High	/integrationslist.php
Setting Up Integrations	✅	✅	❌	High	Integration pages
Order Rules (Automation)	✅	✅	❌	High	/rules.php?type=orders
3PL Carrier Management	✅	✅	❌	High	/billingCarrier.php

---

Shipping & Rates (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Shipping Estimates	✅	✅	❌	High	/rates.php, /Allpack_Rateslist.php
Rate Shopping	✅	✅	❌	High	Rate views

---

Reports & Analytics (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Reports Overview	✅	✅	❌	High	/standard_reports_csv.php
Standard Reports	✅	✅	❌	High	/SpecialReportstCsvlist.php
Business Intelligence	✅	✅	❌	Medium	/BusinessIntelligencelist.php
Custom Reports	✅	✅	❌	Low	Report views

---

My Account (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Account Overview	✅	✅	❌	Medium	/Front_tittle.php
Preferences	✅	✅	❌	Medium	/PreferencesSenttinglist.php
Change Password	✅	✅	❌	Medium	/changepass.php
Statements & Invoices	✅	✅	❌	Medium	/Invoiceslist.php
Payment History	✅	✅	❌	Medium	/GatewayHistorySeller_list.php
Disputes	✅	✅	❌	Medium	/Disputeslist.php
Gateway Methods	✅	❌	❌	Low	/GatewayListMethod_list.php
Gateway Errors	✅	❌	❌	Low	/gateway_list_errors.php
Profit Reports	✅	❌	❌	Low	/profits.php
All Transactions	✅	✅	❌	Medium	/all_transactions.php
Exos Connection	✅	❌	❌	Low	/secure_exos_connection.php

---

Special Features (OMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
My Shelf	✅	❌	❌	Low	/myshelf_orderlist.php

---

WMS (Warehouse Management System)

Orders - Warehouse View

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Wall Communication	✅	✅	❌	Medium	/vpb_wall.php
Pending Orders	✅	❌	❌	High	/pending_orders.php, /Order_List_Pendding_Alist.php
Processing Orders	✅	❌	❌	High	/shipping.php, /Order_List_Processing_Alist.php
Picking Operations	✅	❌	❌	High	/picking.php
Picking Log	✅	✅	❌	Medium	/picking_log.php
Batch Processing	✅	❌	❌	High	/batches.php
Shipping Labels	✅	✅	❌	High	/shipping_labels2.php
Shipped Orders	✅	✅	❌	High	/shipped_orders.php, /Order_List_Shipped_Alist.php
All Orders	✅	❌	❌	High	/all_orders.php, /All_Orders_Alist.php
Print History	✅	❌	❌	Medium	/logprintlist.php
Pick Log	✅	❌	❌	Medium	/logpick.php

---

Inventory - Warehouse View

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Warehouse Overview	✅	❌	❌	High	/warehouse.php, /Bin_vlist.php
Catalog Management	✅	❌	❌	High	/cataloglist.php
Bin Management	✅	❌	❌	High	Bin views
Locations	✅	❌	❌	High	/locationlist.php
Serials Management	✅	❌	❌	Medium	/serialslist.php
Procedures	✅	❌	❌	High	/Class_Allpacklist.php
Receiving	✅	❌	❌	High	/Recive_Requestlist.php
Replenishments	✅	❌	❌	High	/Recive_Requestlist.php
Archived Replenishments	✅	❌	❌	Medium	/replenishment_archived_whlist.php
Returns	✅	❌	❌	High	/Retun_orderslist.php
Archived Returns	✅	❌	❌	Medium	/return_archived_whlist.php
Corrections (Recounts)	✅	❌	❌	High	/Correction_Detaillist1.php
Editing Bins	✅	❌	❌	Medium	/editingBinlist.php
Bin Mirror	✅	❌	❌	Medium	/binmirror.php
Packaging	✅	❌	❌	Medium	/packaging.php, /Packaginglist.php
Units of Measure (UOM)	✅	❌	❌	Low	/uomlist.php
Inventory Allpack	✅	❌	❌	High	/Inventory_Allpacklist.php

---

Warehouse Billing & Reporting

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Dashboard	✅	❌	❌	High	/dashboard.php
Reports	✅	❌	❌	High	/standard_reports_csv.php
OMS Accounts	✅	❌	❌	Medium	/acountslist.php
Daily Storage	✅	❌	❌	High	/dailyStorage.php
Statements	✅	❌	❌	Medium	/StatementsWHlist.php
Disputes	✅	❌	❌	Medium	/Disputeslist.php
Service Summary	✅	❌	❌	Medium	/InvoiceViewWHlist.php
Shipping Estimates	✅	❌	❌	Medium	/rates.php
Generated Costs	✅	❌	❌	High	/invoices_whlist.php
Custom Templates	✅	❌	❌	Low	/packingListOms.php
Project Clock	✅	❌	❌	Low	/project.php

---

3PL Billing (WMS Admin)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
3PL Billing Overview	✅	❌	❌	Medium	3PL menu
Premium Services	✅	❌	❌	Medium	/premium_services.php
Service Summary	✅	❌	❌	Medium	/InvoiceViewAdmlist.php
Price Plans	✅	❌	❌	Medium	/Pricingplanlist.php
OMS Client Prices	✅	❌	❌	Medium	/PriceListlist__.php
OMS Client Statements	✅	❌	❌	Medium	/InvoicesAlist.php
Shipping Methods	✅	❌	❌	Medium	/method_shippinglist.php
Shipping Discounts	✅	❌	❌	Medium	/SurchargesCarrierlist.php
All OMS Transactions	✅	❌	❌	Medium	/all_transactions.php
Billing Adjustments	✅	❌	❌	Medium	/adjustment_admin.php
Payments	✅	❌	❌	Medium	/gateway_Account_History_list.php

---

4PL Billing (WMS Admin)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
4PL Billing Overview	✅	❌	❌	Low	4PL menu
All Transactions	✅	❌	❌	Low	/invoices_whlist.php
Statements	✅	❌	❌	Low	/StatementsWHlist.php
Dispute Verdicts	✅	❌	❌	Low	/Disputeslist.php
3PL Costs to 4PL	✅	❌	❌	Low	/services_whlist.php

---

System Configuration (WMS)

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Preferences	✅	❌	❌	Medium	/preferencesSettings.php
Change Password	✅	❌	❌	Medium	/changepass.php
Timesheet	✅	❌	❌	Low	/punchcard_viewlist.php
Server Status	✅	❌	❌	Low	/server_status.php
Email Configuration	✅	❌	❌	Medium	/email_configuration.php
Automation Rules	✅	❌	❌	High	/rules.php
Email Templates	✅	❌	❌	Medium	/config_emails_whlist.php

---

Advanced Features

Bin Management & Operations

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Bin Overview	✅	❌	❌	High	/bin.php
Bin Lists	✅	❌	❌	High	/binlist.php
Bin Flow	✅	❌	❌	Medium	/bin_flow.php
Bin Refill	✅	❌	❌	Medium	/bin_flow_refill.php
Assign Bins	✅	❌	❌	High	/AssignBinlist.php
Assign Pre-Bins	✅	❌	❌	Medium	/AssignPreBinlist.php
Bin History	✅	❌	❌	Medium	/BinHistory_Allpacklist.php
Bin Tags	✅	❌	❌	Low	Bin tag views

---

Carriers & Shipping

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Carriers List	✅	❌	❌	Medium	/Carriers_Listlist.php
Carrier Packages	✅	❌	❌	Medium	/addCarrierPackage.php
Carrier Manifest	✅	❌	❌	Medium	/carrier_manifest.php
Carrier Open/Close	✅	❌	❌	Low	/CarrierOpenClose.php

---

Labels & Printing

Documentation Page	AI Draft	QA Review	Ready	Priority	App View
Label Management	✅	❌	❌	High	Label views
Shipping Labels	✅	✅	❌	High	/shipping_labels2.php
Packing Lists	✅	❌	❌	Medium	Packing views

---

Documentation Progress Summary

Overall Statistics

Total Documentation Pages: 153

Progress:
✅ Complete: 0 (0%)
🚧 In Progress: 17 (11.1%)
❌ Not Started: 136 (88.9%)

Recent Changes

• Initial Creation: Complete documentation checklist for ShipEdge.core
• Organized by OMS/WMS: Clear separation between Order Management and Warehouse Management
• All Main Views Covered: Based on actual menu structure from codebase
• Frontend Focus: Only user-facing views included (OMS/WMS admin views included, system admin excluded)
• System Admin Excluded: Removed system-level admin views (company management, system settings)

Priority Breakdown

• High Priority: 68 pages (Core daily workflows)
• Medium Priority: 73 pages (Configuration and setup features including 3PL/4PL billing)
• Low Priority: 12 pages (Advanced features)

---

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 Orders” 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: November 10, 2025