-
Notifications
You must be signed in to change notification settings - Fork 436
[Docs] fix after reorganize incorrect file path #1271
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @nicole-lihui, 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 primarily focuses on rectifying outdated file paths and commands across various documentation files. This is a direct follow-up to a previous reorganization (PR #455), aiming to synchronize the documentation with the current repository structure. The changes ensure that all links and setup instructions are accurate, improving the overall usability and correctness of the project's documentation.
Highlights
- Documentation Link Updates: I've updated several internal and external documentation links within
CONTRIBUTING.md
to reflect the reorganizeddevelopment
anddevelopment/tutorials
directories, ensuring all references point to the correct locations. - Kubectl Command Corrections: I've corrected
kubectl
deployment commands indevelopment/tutorials/podautoscaler/README.md
andpkg/metadata/README.md
. This includes updating configuration paths (e.g., fromdocs/development/app/deployment.yaml
todevelopment/app/config/simulator
orconfig/metadata/metadata.yaml
) and, in one case, changing the command fromkubectl apply -f
tokubectl create -k
for consistency with the new structure. - Internal README Reference Fix: I've adjusted a comment reference in
python/aibrix/aibrix/gpu_optimizer/README.md
to point to the correctdevelopment/app/README.md
path, ensuring users are directed to the right place for simulator details. - Minor Formatting Fixes: I've addressed missing newlines at the end of
pkg/metadata/README.md
andpython/aibrix/aibrix/gpu_optimizer/README.md
for better file hygiene.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request fixes incorrect file paths in the documentation after a reorganization of the project structure. The changes involve updating the file paths in several README files to reflect the new directory structure.
fe0334a
to
726d7b8
Compare
…lm-project#455 Signed-off-by: nicole-lihui <nicole.li@daocloud.io>
726d7b8
to
496761e
Compare
Great! I really appreciate the fix. |
fix reorganize docs/development and docs/tutorial structure for pr vllm-project#455 Signed-off-by: nicole-lihui <nicole.li@daocloud.io>
Pull Request Description
[Please provide a clear and concise description of your changes here]
fix pr #455 other README docs no sync, incorrect file path
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]
: Corrections to existing functionality[CI]
: Changes to build process or CI pipeline[Docs]
: Updates or additions to documentation[API]
: Modifications to aibrix's API or interface[CLI]
: Changes or additions to the Command Line Interface[Misc]
: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.