Document the /aviator help slash command - #140
Open
brain-crystal wants to merge 1 commit into
Open
Conversation
Add a Help section to the MergeQueue slash commands reference covering what the command posts, that the list is not filtered by which products are enabled, and the unrecognized-command suggestion. Point at it from the slash commands how-to guide, add a help pointer plus Refresh and Breakglass sections to the FlexReview reference, and note in the Runbooks feedback guide that /aviator revise appears in the help output. Claude-Session: https://claude.ai/code/session_011oFBnjaoTAAv8MZhoy5Mdm
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
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.
/aviator helpwas missing from the docs. This documents it across the pages where a reader would look for it.mergequeue/reference/slash-commands.md— new## Helpsection as the first section: what the command posts, an info hint that the list is not filtered by enabled products (and that a command for a disabled product will not perform the action), and the unrecognized-command suggestion. Frontmatterdescription:extended to mention help.mergequeue/how-to-guides/slash-commands.md— one paragraph after the/aviator refreshexample pointing at/aviator help, linking to the reference page.flexreview/reference/flexreview-slash-commands.md— top info hint pointing at/aviator help, plus### Refreshand### Breakglasssections in the existing Suggest/Assign style. Breakglass links to the existing breakglass scenarios anchor.runbooks/how-to-guides/providing-feedback.md— one line noting/aviator revisealso appears in the help output.Verified against
aviator-co/mergeit,src/core/slash_commands.py: the help groups (MergeQueue, FlexReview, Runbooks, Git Operations), that_handle_flexreview_refreshdispatches bothprocess_fr_teamsandprocess_fr_approvals, and that--reasonon breakglass isrequired=True.Two things worth knowing, neither addressed here:
validate-config,stack merge,stack cancelandmerge --targets, none of which help lists. It drifts the other way too: help advertisesmerge --skip-line/--skip-validationandbackport --use-new-backport, which the reference page does not document. That is a backend fix, not a docs one.Unknown /aviator commandrather than quoting it verbatim, since the real string interpolates the typed command.https://claude.ai/code/session_011oFBnjaoTAAv8MZhoy5Mdm