Skip to content

Epic: AI onboarding docs alignment (contract + workflow + tests + product docs) #6

@Whiteks1

Description

@Whiteks1

Epic: AI onboarding docs alignment (contract + workflow + tests + product docs)

Canonical root path

All AI documentation paths in this Epic are under: docs/ai/

Goal

Make AI onboarding documentation internally consistent and implementable by aligning:

  • API contract
  • executable workflow YAML
  • acceptance tests
  • product/UX documentation

Scope (docs only)

This Epic is limited to documentation artifacts under:

  • docs/ai/api/
  • docs/ai/workflows/
  • docs/ai/tests/
  • docs/ai/product/
  • docs/ai/agents/

No backend/frontend implementation work is included.

Canonical onboarding for this Epic

Workflow: onboarding_basic

States (expected):
startask_nameask_goalsummaryend

Important rule: No extra questions in summary or end.

Tasks (create each as a child issue)

  • doc: Finalize CONTRACT_onboarding_action.md (examples + state/action table)
  • core: Align onboarding_basic.yaml with contract (states + transitions)
  • doc: Align onboarding_basic tests with workflow + contract (acceptance criteria)
  • doc: Product coherence (executed onboarding_basic vs design-only guide UI) + agents mapping
  • chore: Repo hygiene + merge readiness notes for integrating into main andhis repo

Completion criteria

All 5 child issues are merged into dev, linked/closed, and the docs present a single coherent onboarding definition (contract ↔ workflow ↔ tests ↔ product docs).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions