-
Notifications
You must be signed in to change notification settings - Fork 25
Authoring workflow definitions #796
Copy link
Copy link
Open
Labels
design-data-specDesign Data Specification / SDK effortDesign Data Specification / SDK effort
Milestone
Description
Context
Part of Epic #732 — Phase 4: Output generators and authoring app integration.
Before building the authoring app UI, we need structured workflow documents that formalize the git-based editing model. These serve as both requirements and input for wireframe generation.
Goal
Produce a set of Markdown workflow documents in docs/authoring-app/workflows/ that define every user-facing editing operation with enough precision to generate wireframes and derive validation rules.
Workflows to define
- Create token — new token with name object, value, UUID, optional dimensions
- Edit token value — change value for specific dimension context
- Deprecate token — set
deprecatedversion,deprecated_comment,replaced_by, optionalplannedRemoval - Rename token — new name object +
replaced_byon old token (or just new UUID assignment) - Add dimension variant — add
colorScheme=darkvariant of existing token - Bulk operations — deprecate/rename a batch of tokens (layout consolidation pattern)
- Review changes — diff preview before PR creation
- Resolve validation errors — real-time SPEC rule feedback during editing
Each workflow document must include
- Preconditions (what state the data must be in)
- Steps (user actions + system responses)
- Postconditions (what the data looks like after)
- Validation constraints (which SPEC rules apply)
- Git operations (branch, commit, PR)
Acceptance criteria
- All 8 workflows documented in
docs/authoring-app/workflows/ - Each document follows the standard structure above
- SPEC rule references are accurate (SPEC-001 through SPEC-013)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
design-data-specDesign Data Specification / SDK effortDesign Data Specification / SDK effort