Skip to content

Align ways-of-working guidance with the issue model #86

Description

The new issue model changes assumptions currently repeated across workflow, readiness, branching, goal-setting, specification, pull-request, agent-workflow-stage, and orchestration guidance. Those pages must agree that aggregate issues plan and track while delivery leaves build and ship.

Request

Update every affected Ways of Working and agent-facing page to consume the canonical OKF issue guidance without restating it. Ensure phases, readiness, closure, pull-request linking, stacked-work dependencies, and indexes-first workflow discovery reflect native issue types and relationships.

Acceptance criteria

  • Workflow sends only Task/Bug delivery leaves into Build; Epic/PBI decompose and aggregate
  • Definition of Ready and Done defines level-appropriate gates for aggregate versus leaf issues
  • Branching and Merging uses native issue dependencies rather than textual Blocked by conventions
  • PR Format closes exactly one Task/Bug and references parent PBI/Epic without closing keywords
  • Goal Setting clarifies the Mission → OKR → Initiative → Epic boundary and the issue-type strategy above Epic
  • Spec-Driven Development uses the canonical Epic/PBI/Task/Bug terminology and links to the new pages
  • Contribution Workflow, Documentation Model, Fleet Orchestration, and Agent Workflow stage pages use the new paths and semantics
  • Workflow is the canonical process entry; the Workflow Stages index only routes to stage procedures
  • Root AGENTS.md preserves repository-specific operational policy from the live base: continuous improvement/issue escalation, ecosystem setup topology, docs-versus-memory contribution modes, repository-local identity, README/CONTRIBUTING orientation, memory use, and micro-commit/push discipline
  • The docs installation uses a bare backing repository with ~/.msx/docs as the readable clean main worktree; memory remains a simple main checkout, and unsafe legacy topology cannot be silently converted or discarded
  • The bootstrap is pluggable for additional projects with their own docs and memory; every project uses bare docs plus a canonical default worktree and simple memory, with validated non-overlapping workspace paths
  • Restored root instructions link to canonical Workflow stages rather than copying stage procedures
  • Discovery refreshes the local ~/.msx/docs checkout before following AGENTS.md -> docs root -> Ways of Working -> Workflow -> inferred stage; explicit task keywords may shortcut to a stage without creating another process definition
  • A failed local docs refresh stops discovery with an explicit error; it never silently continues through stale documentation
  • Bootstrap synchronization has hermetic regression coverage for successful exact refresh and rejection of unsafe or unavailable context states
  • Stage procedures live under Ways-of-Working/Workflow-Stages/; no src/docs/Agents/ compatibility stubs, duplicates, or stale paths remain
  • No page redefines body structures, hierarchy, or relationship semantics owned by the Issues section
  • Index check, links, lint, clean build, CI, and Copilot review are green

Technical decisions

Reference, do not restate: The Issues section owns the model. Other pages state only their local consequence and link to the canonical page.

Leaf pull requests: A pull request closes its Task/Bug delivery issue. PBI/Epic links are contextual and non-closing.

Native dependencies: Stacked pull requests mirror issue dependency edges; list order and prose do not create execution gates.

Agent workflow stages: src/docs/Ways-of-Working/Workflow-Stages/ contains the stage procedures and handoffs for one shared workflow, not standalone agent roles or personas. The obsolete src/docs/Agents/ path is removed atomically. Bootstrap and framework guidance use the same model.

Repository pointer scope: Thin means no copied canonical process; it does not mean deleting repository-specific setup, contribution, memory, identity, or delivery policy. Root AGENTS.md preserves those local obligations and links outward for Workflow stages.

Workspace topology: MSXOrg/docs uses a bare backing repository and worktrees, with the canonical clean main worktree readable at ~/.msx/docs; topic worktrees use concise folders and typed issue branches. MSXOrg/memory remains a simple checkout on main. Bootstrap must preserve or safely migrate supported existing states and fail explicitly rather than destructively converting an unsafe state.

Project plug-ins: Additional projects provide docs and memory coordinates to the same bootstrap. Project roots, checkouts, bare backing stores, and migration backups must be normalized and pairwise non-overlapping before any filesystem mutation.

Refresh-first, indexes-first discovery: Refresh the canonical local ~/.msx/docs checkout before traversing its indexes. If refresh fails, stop and surface the failure rather than silently using stale guidance. Workflow.md owns process progression and stage selection. Root and section indexes lead to it; Workflow-Stages/index.md, skills, instruction files, agent definitions, and repository pointers only route to stage procedures and never copy the workflow.


Implementation plan

Workflow alignment

  • Update workflow, readiness/done, branching, PR, goal-setting, and spec-driven pages
  • Update contribution, documentation-model, orchestration, and Agent Workflow stage consumers
  • Make Workflow canonical and align indexes-first stage discovery without duplicate process definitions
  • Atomically relocate stage procedures from src/docs/Agents/ to Ways-of-Working/Workflow-Stages/
  • Refresh ~/.msx/docs before index traversal and fail explicitly when refresh cannot complete
  • Align bootstrap, template, framework, and workflow-discovery wording with the refresh-first contract
  • Add hermetic regression coverage for exact synchronization and fail-closed refresh states
  • Restore the material repository-specific root AGENTS.md contract without copying Workflow stage definitions
  • Align bootstrap, template, tests, and guidance with a bare docs backing repo plus canonical ~/.msx/docs main worktree and simple memory checkout
  • Prove pluggable project topology and reject exact, ancestor, and descendant workspace-path collisions before mutation
  • Remove duplicated legacy terminology and textual relationship conventions

Validation

  • Search the full documentation tree for stale paths and semantics
  • Run documentation checks, CI, and the Copilot review loop

Metadata

Metadata

Labels

NoReleaseNo release required

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions