docs: remove obsolete file doc/cli-commands.md#2669
Conversation
Summary of ChangesHello @parthea, 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 streamlines the project's documentation by eliminating an outdated manual CLI commands file. The change reflects an upgrade in the documentation process, moving from static, manually maintained files to a dynamic generation system that automatically creates and updates CLI documentation based on the application's help text. This improves accuracy and reduces maintenance overhead. Highlights
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 aims to remove the obsolete doc/cli-commands.md file, which is a good cleanup in principle. However, I've found a significant issue in the test for the new automatic documentation generation system that is intended to replace it. The test appears to be verifying the wrong file, which undermines the reliability of the new system. I've added a detailed comment on the removed file. I recommend fixing the test before merging this change to ensure the CLI documentation remains accurate and up-to-date.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2669 +/- ##
=======================================
Coverage 86.93% 86.93%
=======================================
Files 108 108
Lines 9194 9194
=======================================
Hits 7993 7993
Misses 861 861
Partials 340 340 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
3 participants
As per #2647 (comment), we now have a system that keeps cli docs up-to-date as we change them. We dynamically create docs based on helptext: https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian.
This PR removes the obsolete file
doc/cli-commands.md