Skip to content

Generate migration guidance from one canonical contract #811

Description

@flyingrobots

Why

The v18-to-v19 command, root README, migration guide, and scripts/v18-to-v19/README.md currently repeat graph examples, flag semantics, and execution steps. The published --graph events example already demonstrated how copied guidance can drift from real repositories that host arbitrary, multiple graph namespaces.

Outcome

Define one canonical migration CLI/documentation contract and generate or mechanically verify every repeated command synopsis and example against it.

Acceptance criteria

  • One source owns flag names, default behavior, confirmation semantics, and example placeholders.
  • Root README, v19 migration guide, script README, and --help cannot disagree unnoticed.
  • Examples use explicit placeholders and demonstrate discovered graph names rather than implying events is special.
  • Documentation tests execute or snapshot the canonical examples.
  • Error examples cover repository-not-found, graph-not-found, empty repository, and upgrade-not-needed states.
  • The solution does not keep v18 runtime compatibility code in the v19 application path.

Related work

Follow-up debt from #806 and the migration-guide requirements tracked by #810. It is not a blocker for the immediate v19 correction unless the current fixes add another independently maintained copy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsPrimary work area: docs.priority:laterDeferred or speculative work.status:availableOpen and available for prioritization; not blocked or actively in progress.type:debtDebt, rot, or structural risk.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions