Skip to content

Keep canonical ORRO command surface and documentation in sync after alias removals #136

Description

@moonweave

Observed

The installed ORRO wrapper help says the sketch/trace, next, and report aliases were removed in 2.27.0 and points users to advise, auto --dry-run, and status. The same help also identifies the explicit delegated engine command as the authoritative workflow surface.

The checked-in documentation still contains active examples and contract text using the removed forms, including:

  • orro report .witnessd/runs/<run-dir> --home .witnessd in README.md and docs/workflow-reference.md;
  • orro next and orro report in docs/e2e-smoke-contract.md;
  • the old command chain without a clearly marked migration-only context.

A fresh operator following the repository docs can therefore receive an unknown/deprecated-command error even though the wrapper help advertises a different canonical path.

Expected behavior

Keep one canonical command table and update every active README, workflow reference, smoke contract, and example when aliases are removed. Keep old names only in a clearly labeled migration/compatibility section or test fixture.

Suggested acceptance criteria

  • Replace active orro next/orro report examples with the supported auto --dry-run/status forms.
  • State one canonical invocation rule for wrapper-owned versus delegated workflow commands.
  • Add a documentation drift check that fails on removed commands outside migration notes and fixtures.
  • Verify the quickstart and E2E smoke contract against the current orro --help surface.

Evidence collected against the installed release set on 2026-07-26.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions