Pyle

Task Guides ​

Purpose ​

Task guides are reusable, user-facing workflow pages for repeated operational actions in Pyle.

They are different from concept pages:

  • concept pages explain what a feature is
  • task guides explain exactly how to complete one practical workflow

What A Task Guide Is For ​

Use a task guide when a reader wants to do one thing right now, for example:

  • create a product
  • classify a product
  • configure product groups
  • export catalog setup

Task guides should be short, practical, and written for operators rather than developers.

Quick checklists are a lighter companion format for high-frequency troubleshooting cases.

  • use a full task guide when the reader needs the full workflow and explanation
  • use a quick checklist when the reader needs a fast triage pass before opening the full guide

Writing Rules ​

Every task guide must:

  • start with the business outcome, not the code concept
  • name the real admin entry point the user clicks into
  • state prerequisites and missing setup clearly
  • distinguish direct user steps from automatic downstream behavior
  • explain what changes after the task is saved or completed
  • warn about the most common failure modes for that exact workflow

Avoid:

  • generic feature explanations that belong in concept pages
  • code terms such as models, controllers, observers, or migrations
  • vague instructions like "configure this as needed"
  • invented packaged UI flows that do not exist in the repo

Evidence Standard ​

Research task guides in this order:

  1. packaged admin screens and dialogs
  2. storefront pages affected by the task
  3. import/export screens
  4. ERP or sync touchpoints when they change how the task works
  5. framework code only to confirm hidden rules or side effects

Required Page Structure ​

Every task guide should use this structure:

md
# <How To ...>

## What This Task Does

## Before You Start

## Steps

## What Happens Next

## Common Mistakes

## Related Guides

Section Expectations ​

What This Task Does ​

Explain:

  • the outcome the user is trying to reach
  • when this task is the right one
  • what successful completion looks like

Before You Start ​

Explain:

  • permissions
  • records or setup that must already exist
  • whether the task is direct UI work, Excel work, or generated/system-assisted work

Steps ​

Use numbered operational steps:

  1. where to go
  2. what to click
  3. which fields matter
  4. what to save or confirm

Only include steps the user can actually perform in the packaged product.

What Happens Next ​

Explain:

  • what updates immediately
  • what affects storefront browsing, product pages, or shopper options
  • what may require background rebuilds, syncs, or related setup to become visible

Common Mistakes ​

List the most important workflow-specific problems such as:

  • missing prerequisite records
  • trying to delete or disable something still in use
  • expecting storefront changes from a configuration that is only indirect
  • using the wrong screen when the packaged product manages the workflow elsewhere

Link to:

  • the parent domain page
  • relevant end-user concept pages
  • adjacent task guides in the same workflow chain

Current Catalog Task Guides ​

Current Pricing Task Guides ​

Current Customer Task Guides ​

Current Inventory Task Guides ​

Current Fulfillment & Shipping Task Guides ​

Current Order Lifecycle Task Guides ​

Current Payments & Billing Task Guides ​

Current Tax & Territory Task Guides ​

Current Supporting Platform Capabilities Task Guides ​

Current Operations And Troubleshooting Task Guides ​

Current Operations And Troubleshooting Quick Checklists ​

Roadmap Status ​

All current top-level domains in the first-pass documentation roadmap have now been drafted.

The active next pass is cross-domain troubleshooting and recovery guidance for operators. The first troubleshooting batch is now in place.

Sources ​

  • packages/storefront/routes/web.php
  • packages/storefront/src/Livewire/Storefront/Product
  • packages/storefront/src/Livewire/Storefront/Category
  • packages/storefront/src/Livewire/Storefront/Brand
  • packages/framework/src/Http/Controllers/Api/Admin/FulfillmentRequestsController.php
  • packages/framework/src/Http/Controllers/Api/Storefront/ShippingController.php
  • packages/storefront/src/Livewire/Storefront/Cart/Shipments