documentation for commands#81
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @az-smartling, 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 introduces a new capability to the smartling-cli by adding a command that automatically generates comprehensive markdown documentation for all its commands and subcommands. This significantly improves the discoverability and understanding of the CLI's functionality for users and developers alike.
Highlights
- New Documentation Generation Command: A new
docscommand has been added to the CLI, allowing users to generate comprehensive markdown documentation for all CLI commands and their options. - Automated Documentation Output: Executing the
docscommand now creates adocs/directory containing detailed markdown files for each command and subcommand, includingsmartling-cli.md,smartling-cli_files.md,smartling-cli_projects.md, and their respective subcommands, along with shell completion instructions. - Makefile Integration: A new
docstarget has been added to theMakefileto simplify the process of generating this documentation with a single command. - Dependency Updates: New Go modules (
go-md2man/v2,blackfriday/v2) have been added to support the markdown documentation generation, and existing Go module dependencies have been updated.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new docs command to generate markdown documentation. I've identified a high-severity issue where the command incorrectly reports success even when documentation generation fails, and a medium severity issue in the Makefile where the docs target does not handle errors.
# Conflicts: # go.mod # go.sum # main.go
.md documentation and command to generate the documentation