# ISIS v2 UI Icon Pack Operator/Creator Documentation with Troubleshooting

Generated: 2026-08-02T18:38:29.048Z Checklist: `MXA-0306` (ISIS2-00504) Asset
Family: `ui-icon-pack` Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to
2026-10-30)

## Objective

Publish creator and operator documentation with troubleshooting for ui-icon-pack
workflows, spanning workflow authoring, guardrail operations, regression
diagnostics, and downstream integration remediation.

## Persona Coverage

| Persona    | Workflow Focus                                              | Coverage Signals                |
| ---------- | ----------------------------------------------------------- | ------------------------------- |
| `creator`  | Workflow authoring, variant controls, typed submission      | controls=84, validationRules=45 |
| `operator` | Guardrails, regression, integration and runbook diagnostics | envKeys=15, troubleshooting=6   |

## Workflow Coverage

| Workflow                           | Creator UI Documentation | Operator Policy Documentation | Troubleshooting Coverage |
| ---------------------------------- | ------------------------ | ----------------------------- | ------------------------ |
| `ui-icon-pack-baseline`            | yes                      | yes                           | yes                      |
| `ui-icon-pack-image-conditioned`   | yes                      | yes                           | yes                      |
| `ui-icon-pack-control-conditioned` | yes                      | yes                           | yes                      |
| `ui-icon-pack-consistency-locked`  | yes                      | yes                           | yes                      |

## Troubleshooting Matrix

| Issue                                     | Signal                                          | Persona    | Source Coverage |
| ----------------------------------------- | ----------------------------------------------- | ---------- | --------------- |
| `creator-contract-validation-failure`     | `INVALID_WORKFLOW_RUN_REQUEST`                  | `creator`  | yes             |
| `budget-hard-limit-exceeded`              | `UI_ICON_PACK_BUDGET_GUARDRAIL_LIMIT_EXCEEDED`  | `operator` | yes             |
| `quality-gate-failed`                     | `UI_ICON_PACK_QUALITY_GATE_FAILED`              | `operator` | yes             |
| `regression-quality-drift`                | `regression-ui-icon-pack-quality-drift`         | `operator` | yes             |
| `regression-output-package-contract-miss` | `regression-ui-icon-pack-package-contract-miss` | `operator` | yes             |
| `downstream-trigger-integration-drift`    | `workflow-trigger-endpoint-mismatch`            | `operator` | yes             |

## Creator Quickstart

- Select the ui-icon-pack workflow variant that matches the shot intent and
  control profile.
- Complete required icon concept/domain/style/shape/grid/contrast/palette fields
  plus any conditional reference, control-map, or continuity-lock parameters
  before submit.
- Use side-by-side output comparison to verify icon silhouette consistency,
  readability, palette stability, and continuity-lock behavior before approval.
- Export to downstream engine or DCC targets using recipe metadata for
  asset-family traceability.

## Operator Diagnostics Surface

- `X-UI-Icon-Pack-Estimated-Cost-Usd`
- `X-UI-Icon-Pack-Budget-Guardrail-Mode`
- `X-UI-Icon-Pack-Budget-Guardrail-Reason`
- `X-UI-Icon-Pack-Quality-Gate-Mode`
- `X-UI-Icon-Pack-Quality-Gate-Reason`
- `X-UI-Icon-Pack-Quality-Failing-Metrics`

## Verification Commands

- `pnpm --filter @isis/web exec vitest run src/pages/ui-icon-pack-ui-utils.spec.ts src/pages/WorkflowDetailsPage.spec.tsx`
- `pnpm --filter @isis/generation-api exec vitest run src/routes/ui-icon-pack-budget-utils.spec.ts src/routes/ui-icon-pack-quality-gate-utils.spec.ts src/routes/ui-icon-pack-regression-golden-dataset.spec.ts`
- `pnpm --filter @isis/client exec vitest run src/examples/external-integrations.spec.ts src/examples/ui-icon-pack.spec.ts`

## Acceptance Criteria

- Creator documentation covers all ui-icon-pack workflow variants, required
  controls, validation constraints, and typed SDK run paths.
- Operator documentation covers budget and quality guardrail policies, required
  environment keys, regression diagnostics, and monitoring headers.
- Troubleshooting matrix includes creator-input, budget, quality, regression,
  and downstream integration remediation flows with concrete source
  traceability.
- Published documentation remains reproducible through generator/validator
  scripts and evidence-linked governance artifacts.

## Traceability

- Checklist item: `MXA-0306`
- Ticket key: `ISIS2-00504`
- Linked checklist dependencies: `MXA-0299`, `MXA-0300`, `MXA-0301`, `MXA-0302`,
  `MXA-0303`, `MXA-0304`, `MXA-0305`
