update man-pages and help strings#646
Conversation
Create a new man page for the `av squash` command and add it to the main subcommands list. - Create `/code/docs/av-squash.1.md` with standard man page structure (NAME, SYNOPSIS, DESCRIPTION, EXAMPLES, SEE ALSO) - Set NAME section to "av-squash - Squash commits of the current branch into a single commit" - Add SYNOPSIS showing `av squash` with no flags - Document in DESCRIPTION that it squashes all commits on current branch into a single commit, performs a soft reset to the first commit, and amends it - Note that it requires a clean working directory and will not work on merged branches - Add EXAMPLES section showing typical usage - Include SEE ALSO references to av-commit(1) and av-restack(1) - Open `/code/docs/av.1.md` and add entry for `av-squash(1)` in alphabetical order in the SUBCOMMANDS section: "- av-squash(1): Squash commits of the current branch into a single commit" (insert between av-split-commit and av-switch)
Update the root command man page to document global flags available to all commands. - Open `/code/docs/av.1.md` and add an OPTIONS section after SUBCOMMANDS - Document `--debug` flag: "Enable verbose debug logging" - Document `-C <directory>, --repo=<directory>` flag: "Directory to use for git repository" - Follow the same formatting style as other man pages (using definition list syntax with backticks)
Update av-adopt and av-tree man pages to include missing flags. - Open `/code/docs/av-adopt.1.md` and add `--dry-run` flag entry in the OPTIONS section (between --parent and --remote): "Show what branches would be adopted without actually adopting them" - Open `/code/docs/av-tree.1.md` and add an OPTIONS section after DESCRIPTION if it doesn't exist - Document `--current` flag in av-tree: "Show only the current stack (current branch and its ancestors/descendants)" - Use standard option documentation format with definition lists and backticks
…nd av-split-commit.1.md Add SYNOPSIS sections to the three man pages that are missing them. - Open `/code/docs/av-init.1.md` and add SYNOPSIS section after NAME, before DESCRIPTION with: `av init` - Update the description from "Initialize the repository for Aviator CLI" to "Initialize the repository for `av`" for consistency - Open `/code/docs/av-pr-status.1.md` and add SYNOPSIS section after NAME, before DESCRIPTION with: `av pr status` - Open `/code/docs/av-split-commit.1.md` and add SYNOPSIS section after NAME, before DESCRIPTION with: `av split-commit`
Align man page descriptions with the code's help strings. - Open `/code/docs/av-auth.1.md` and update the NAME section description from "Show info about the logged in user" to "Check user authentication status" to match the code's Short field at `/code/cmd/av/auth.go:19` - Ensure consistency between NAME and DESCRIPTION sections - Open `/code/docs/av-reorder.1.md` and update the DESCRIPTION section to include "edited, squashed" in addition to "dropped, or moved" to match the Long description in `/code/cmd/av/reorder.go:35-36` - Complete phrase should mention that commits can be "edited, squashed, dropped, or moved"
Remove the non-existent --submit flag from the av-pr man page SYNOPSIS. - Open `/code/docs/av-pr.1.md` and locate the SYNOPSIS section (around line 9-12) - Remove `[--submit]` from the synopsis as this flag doesn't exist in the code - Verify the rest of the synopsis matches the actual flags in `/code/cmd/av/pr.go:374-413`
Current Aviator status
This PR was merged using Aviator.
See the real-time status of this PR on the
Aviator webapp.
Use the Aviator Chrome Extension
to see the status of your PR within GitHub.
|
✅ FlexReview StatusCommon Owner:
Review SLO: |
Summary of ChangesHello @tulioz, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the documentation for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides a comprehensive update to the man pages for the av CLI tool. It introduces a new man page for av-squash, adds missing SYNOPSIS and OPTIONS sections to several pages, and refines existing descriptions for clarity and accuracy. These changes significantly improve the quality and completeness of the documentation. I have one minor suggestion for consistency in a code block.
|
/aviator revise |
- Add bash language tag to code block in av-squash.1.md - Add --dry-run flag to SYNOPSIS in av-adopt.1.md - Add --current flag to SYNOPSIS in av-tree.1.md
|
Review comments addressed successfully! Summary of ChangesI've successfully addressed all three review comments: 1. av-squash.1.md (lines 31-33) - Added bash language tag
2. av-adopt.1.md (line 51) - Added --dry-run to SYNOPSIS
3. av-tree.1.md (line 19) - Added [--current] to SYNOPSIS
4. Context file updated
All changes maintain consistency with the existing man page structure and follow the established documentation patterns in the codebase. |
- Change command from `av pr create` to `av pr` in SYNOPSIS - Add missing `--all` flag to SYNOPSIS - Remove standalone `--current` and nest it with `--all` as `[--all [--current]]`
3 participants
This PR was created automatically by Aviator Runbooks.
Runbook URL: https://app.aviator.co/r/159
Executed by: @tulioz
💡 Revise with Runbooks
Use
/aviator reviseto address the feedback provided on this PR:As a PR comment:
/aviator revise- Process all unresolved review comments on the PR/aviator revise [instructions]- Process any unresolved comments and handle additional instructions.As a review comment:
/aviator revise [instructions]to an existing review comment to address that specific thread/aviator revise [instructions]as a review comment to have Runbooks revise that code section based on given instructions.Read the complete guide with examples
Steps
Included in this PR
View all Runbook steps (6 of 6 complete)