Skip to content
ConversionIQ Docs

Component Doc Template

Copy this template for every reusable component under docs/components/**.

Component

Section titled “Component”
  • Name: ComponentName
  • Used in: (link to routes)
  • Ownership: UI / Domain / Shared

Purpose / responsibility

Section titled “Purpose / responsibility”

TBD

Props / inputs / outputs

Section titled “Props / inputs / outputs”
  • Inputs: TBD
  • Outputs (events/callbacks): TBD
  • Side effects: TBD

Variants

Section titled “Variants”

TBD

States

Section titled “States”
  • Default: TBD
  • Loading: TBD
  • Empty: TBD
  • Error: TBD
  • Disabled: TBD

Accessibility requirements

Section titled “Accessibility requirements”
  • Keyboard navigation
  • Focus management
  • ARIA labels
  • Color contrast

Security & privacy considerations (if applicable)

Section titled “Security & privacy considerations (if applicable)”
  • PII exposure risks
  • Permission/role gating
  • Data minimization

Analytics hooks (if applicable)

Section titled “Analytics hooks (if applicable)”
  • Event names + payloads

Dependencies

Section titled “Dependencies”
  • Domain refs: docs/domains/...
  • API refs: (if any)
  • Shared UI refs: (if any)
  • Workflow refs: docs/workflows/... (if any)
  • Prompt / AI refs: docs/prompts/... or docs/ai-governance/... (if any)