Skip to content

manage-environments.md teaches writ inspect --format, a command that does not exist #777

Open

Description

@David-Noble-at-work

Feature: #465 — User-facing guides

docs/guides/writ/manage-environments.md:228-229:

writ inspect noblefactor --format yaml
writ inspect noblefactor --format json

writ inspect is not registered — grep '"inspect' cmd/writ/writ/*.go finds nothing — and
writ-repo-command.md:29 records it as retired, replaced by what is now writ reconcile. --format is
likewise gone: the shared set is --output / -o (#740). So both halves of both lines are dead.

Found by the doc sweep in #774 phase 3, looking for the retired migrate --format. Not part of that
work: this is a stale guide, not an output-convention site. Logged here so it is not rediscovered.

Fix

Rewrite the two lines onto what exists. The likely intent — inspect what writ deployed for one project
— is writ reconcile noblefactor -o yaml, or --jq '.entries' for the delta alone. Read the
surrounding section first; if it describes inspect's behavior rather than merely invoking it, more
than two lines are stale.

Metadata

Metadata

Labels

Epic:DocDebtDesign and documentation debtbugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions