Skip to content

docs: sync modctl man page with CLI and replace hardcoded default path#426

Open
rishi-jat wants to merge 5 commits intomodelpack:mainfrom
rishi-jat:docs/modctl-manpath-fix
Open

docs: sync modctl man page with CLI and replace hardcoded default path#426
rishi-jat wants to merge 5 commits intomodelpack:mainfrom
rishi-jat:docs/modctl-manpath-fix

Conversation

@rishi-jat
Copy link
Contributor

@rishi-jat rishi-jat commented Feb 27, 2026

Description

This PR synchronizes build/package/docs/modctl.1.md with the current modctl --help output.

Changes

  • Standardizes the man page content to match the CLI output exactly
  • Updates outdated specification wording
  • Aligns the Available Commands section with the current root command registration
  • Updates the Flags section to reflect current defaults
  • Replaces hardcoded developer-specific paths with a generic home directory reference (~/.modctl)

The goal is to ensure the man page remains accurate, consistent, and fully aligned with the current CLI behavior.

…rectory

Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Copilot AI review requested due to automatic review settings February 27, 2026 02:52
@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 refines the modctl man page documentation by replacing an environment-specific default path with a more universal representation. This change enhances the accuracy and portability of the documentation, ensuring it is relevant across different user environments without exposing specific developer details.

Highlights

  • Documentation Update: Replaced a hardcoded, developer-specific default storage directory path (/Users/qiwenbo/.modctl) in the modctl man page with a generic home directory reference (~/.modctl).
Changelog
  • build/package/docs/modctl.1.md
    • Updated the default storage directory path from a specific user's home directory to a generic home directory reference.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request aims to fix a hardcoded user-specific path in the documentation. The change replaces the specific path with a generic home directory reference (~/.modctl), which is a good improvement. However, I've added a review comment regarding the maintainability of this change, as it appears to be made to a file that may be auto-generated. Modifying the source of the documentation generation would be a more robust solution.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the modctl man page to avoid a developer-specific default storage directory path by using a generic home-directory-based default.

Changes:

  • Replace the hardcoded default storage directory path in the --storage-dir flag documentation with ~/.modctl.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@rishi-jat rishi-jat closed this Feb 27, 2026
@rishi-jat rishi-jat reopened this Feb 27, 2026
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
@rishi-jat rishi-jat changed the title docs: replace hardcoded storage-dir default path with generic home directory docs: sync modctl man page with CLI and replace hardcoded default path Feb 27, 2026
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Copy link
Member

@chlins chlins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the output after running the command; standardize the command output here completely. I think the description section is also outdated at the moment.

@rishi-jat
Copy link
Contributor Author

Thanks for the review.

I’ve updated the man page to fully match the current modctl --help output and refreshed the description section accordingly. The command output is now standardized and aligned with the CLI.

@rishi-jat rishi-jat requested a review from chlins February 27, 2026 06:49
@rishi-jat rishi-jat force-pushed the docs/modctl-manpath-fix branch from 05a468a to 7245dba Compare February 27, 2026 07:03
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
@rishi-jat rishi-jat force-pushed the docs/modctl-manpath-fix branch from 7245dba to 05605ab Compare February 27, 2026 07:07
@rishi-jat
Copy link
Contributor Author

Note: I used the latest release version (v0.1.2) in the man page header.
When building locally without release flags, modctl version shows v0.0.1.
Please let me know which version the man page should reflect.

Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants