hide configure command and update documentation #252
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThe pull request hides the Class diagram for updated CLI command structureclassDiagram
class CobraCommand {
+string Use
+string Short
+bool Hidden
+ArgsFunc Args
}
class ConfigureCmd {
+newConfigureCmd()
}
ConfigureCmd --|> CobraCommand
CobraCommand : Hidden = true (for configure)
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull Request Overview
This PR hides the configure command from Docker Model Runner's user-facing interfaces. The command allows changing a model's context size but doesn't persist settings and creates model identity issues, which will be addressed separately in #243.
- Marked the
configurecommand as hidden in the CLI - Removed
configurecommand references from documentation tables and YAML metadata - Retained the command's YAML file with hidden flag set to true
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| cmd/cli/docs/reference/model.md | Removed configure command entry from the model commands table |
| cmd/cli/docs/reference/docker_model_configure.yaml | Set hidden: true to hide the command from generated documentation |
| cmd/cli/docs/reference/docker_model.yaml | Removed configure from command name and link lists in the model command metadata |
| cmd/cli/commands/configure.go | Added Hidden: true field to the cobra command definition |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Summary of ChangesHello @ilopezluna, 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 aims to deprecate and hide the 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
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![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 effectively hides the configure command from the CLI and documentation. The changes are consistent across the codebase: the command is marked as hidden in the cobra command definition, and all references to it in the documentation files have been either removed or marked as hidden. This is a good approach to temporarily disable a feature that is pending a replacement. The changes are correct and well-executed.
This pull request hides the
configurecommand for Docker Model Runner from both the CLI and documentation. The most important changes include marking the command as hidden in code, updating documentation to remove references to the command, and ensuring the command does not appear in any user-facing lists.Configure command allows to change the context size of a model but it does not persist and it adds additional issues related to model identity. To configure a model we will use #243 instead.
Summary by Sourcery
Hide the
configurecommand from the CLI and user documentation to prevent its usage and references until it is replaced by the new #243 implementation.Enhancements:
configurecommand’s Hidden flag in the CLI codeconfigureentries from Docker Model Runner reference docs and navigationconfiguredocumentation file as hidden in its YAML metadata