update cli doc #54
update cli doc #54
Conversation
Summary of ChangesHello @JacksonMei, 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 significantly enhances the documentation and command-line interface for environment management. It clarifies the distinction between temporary 'Environment Instances' and persistent 'Environment Services', providing comprehensive guides on their usage and management. The changes also update the underlying configuration schema to support the new service deployment capabilities, offering more granular control over resource allocation and persistence for different environment types. 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 CLI documentation, introducing the new instance and service commands and their configurations. The documentation is well-structured and detailed. I've identified a few minor areas for improvement to enhance clarity and consistency, including a table formatting issue, a potentially confusing configuration example, and inconsistent product naming. My suggestions aim to make the documentation even more user-friendly.
| | `--ttl` | `-t` | Time to live (e.g., 30m, 1h) | 30m | | ||
| | `--env` | `-e` | Environment variables (KEY=VALUE) | - | | ||
| | `--arg` | `-a` | Command line arguments | - | | ||
| | `--system-url` | | AEnv system URL | from env/config | |
There was a problem hiding this comment.
The documentation appears to use AEnvironment, AEnv, Aenv, and aenv inconsistently. For clarity and consistency, I recommend standardizing the naming across all documentation. A good approach would be to use AEnvironment for the project name and aenv for the CLI tool. In this line, AEnv could be changed to aenv if it refers to the CLI, or AEnvironment if it refers to the overall system.
| +------------------+-------------+---------+--------+----------+----------+--------------+----------------------+ | ||
| | Service ID | Environment | Owner | Status | Replicas | Storage | Service URL | Created At | | ||
| +==================+=============+=========+========+==========+==========+==============+======================+ | ||
| | myapp-svc-abc123 | myapp@1.0.0 | user1 | Ready | 3/3 | myapp-pvc| myapp-svc... | 2026-01-19T10:30:00Z | |
There was a problem hiding this comment.
The formatting of this table row appears to be broken due to a missing space around a pipe (|) character between the 'Storage' and 'Service URL' columns. This will likely cause rendering issues in the markdown table.
| | myapp-svc-abc123 | myapp@1.0.0 | user1 | Ready | 3/3 | myapp-pvc| myapp-svc... | 2026-01-19T10:30:00Z | | |
| | myapp-svc-abc123 | myapp@1.0.0 | user1 | Ready | 3/3 | myapp-pvc | myapp-svc... | 2026-01-19T10:30:00Z | |
docs/guide/environments.md
Outdated
| "os": "linux", | ||
| "ephemeralStorage": "5Gi", | ||
| "imagePrefix": "registry.example.com/envs", | ||
| "podTemplate": "", |
There was a problem hiding this comment.
The example shows podTemplate as an empty string, while the description on line 133 states it defaults to "singleContainer". This could be confusing for users. To improve clarity, it would be better if the example explicitly showed the default value.
| "podTemplate": "", | |
| "podTemplate": "singleContainer", |
- Add comprehensive documentation for `aenv instance` and `aenv service` commands in cli.md - Update config.json examples to match official template structure - Add detailed field descriptions for deployConfig.service configuration - Add "Environment Instance vs Environment Service" comparison in concepts.md - Mark optional fields (imagePrefix, podTemplate) explicitly - Fix markdownlint duplicate heading issue Key updates: 1. CLI documentation (docs/guide/cli.md): - Complete documentation for instance subcommands (create, list, get, delete) - Complete documentation for service subcommands (create, list, get, delete, update) - Usage examples and option descriptions for all commands 2. Environment configuration (docs/guide/environments.md): - Updated config.json examples to match official template defaults - Added deployConfig.service fields documentation - Separated core and optional deployment parameters - Added extended configuration examples 3. Core concepts (docs/getting_started/concepts.md): - Added detailed comparison between Instance and Service - Added use cases and management commands - Added comparison matrix with 9 dimensions - Added guidance on when to use which deployment mode Co-Authored-By: Claude <noreply@anthropic.com>
No description provided.