Eve library

ISIS v2 HUD Element Pack Operator/Creator Documentation with Troubleshooting

Guide

Revision 1

On this page

Generated: 2026-03-01T19:01:06.495Z Checklist: MXA-0324 (ISIS2-00522) Asset Family: hud-element-pack Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to 2026-10-30)

Objective#

Publish creator and operator documentation with troubleshooting for hud-element-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=60, validationRules=36
operator Guardrails, regression, integration and runbook diagnostics envKeys=15, troubleshooting=6

Workflow Coverage#

Workflow Creator UI Documentation Operator Policy Documentation Troubleshooting Coverage
hud-element-pack-baseline yes yes yes
hud-element-pack-image-conditioned yes yes yes
hud-element-pack-control-conditioned yes yes yes
hud-element-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 HUD_ELEMENT_PACK_BUDGET_GUARDRAIL_LIMIT_EXCEEDED operator yes
quality-gate-failed HUD_ELEMENT_PACK_QUALITY_GATE_FAILED operator yes
regression-quality-drift regression-hud-element-pack-quality-drift operator yes
regression-output-package-contract-miss regression-hud-element-pack-package-contract-miss operator yes
downstream-trigger-integration-drift workflow-trigger-endpoint-mismatch operator yes

Creator Quickstart#

  • Select the hud-element-pack workflow variant that matches the shot intent and control profile.
  • Complete required hud layout/context/style/typography/contrast/palette fields plus any conditional reference, control-map, or continuity-lock parameters before submit.
  • Use side-by-side output comparison to verify layout anchoring, 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-Hud-Element-Pack-Estimated-Cost-Usd
  • X-Hud-Element-Pack-Budget-Guardrail-Mode
  • X-Hud-Element-Pack-Budget-Guardrail-Reason
  • X-Hud-Element-Pack-Quality-Gate-Mode
  • X-Hud-Element-Pack-Quality-Gate-Reason
  • X-Hud-Element-Pack-Quality-Failing-Metrics

Verification Commands#

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

Acceptance Criteria#

  • Creator documentation covers all hud-element-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-0324
  • Ticket key: ISIS2-00522
  • Linked checklist dependencies: MXA-0317, MXA-0318, MXA-0319, MXA-0320, MXA-0321, MXA-0322, MXA-0323