docs: document and guard the operational --json shapes#85
Merged
Conversation
andyrewlee
force-pushed
the
audit/37-help-json-drift-guard
branch
from
369f927 to
eb6bbac
Compare
AGENT.md described abort/undo/repair only as "small { ... } objects, see
st help <cmd>" — but st help <cmd> renders commandInfo (name/summary/
usage/aliases/flags), which carries none of the result keys, so the
redirect pointed agents at the wrong shape. The emitted keys (aborted,
undone, label, restored, repaired, fixes) appeared in no drift-guard.
Document the three fixed shapes explicitly and extend TestAgentDoc-
DocumentsEmittedKeys to drive abort (over a real paused rebase), undo,
and repair so every key they emit is pinned to AGENT.md, matching the
guard already covering status/checkout/validate/log/navigation.
andyrewlee
force-pushed
the
audit/38-operational-json-shapes
branch
from
d1855c6 to
05d1c2f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AGENT.md described abort/undo/repair only as "small { ... } objects, see
st help " — but st help renders commandInfo (name/summary/
usage/aliases/flags), which carries none of the result keys, so the
redirect pointed agents at the wrong shape. The emitted keys (aborted,
undone, label, restored, repaired, fixes) appeared in no drift-guard.
Document the three fixed shapes explicitly and extend TestAgentDoc-
DocumentsEmittedKeys to drive abort (over a real paused rebase), undo,
and repair so every key they emit is pinned to AGENT.md, matching the
guard already covering status/checkout/validate/log/navigation.
Part of a 38-PR stacked diff (
audit/01…audit/38), reviewed and merged bottom-up. This PR is based onaudit/37-help-json-drift-guard.