[docs] fix concept site references#88
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @slin1237, 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 updates the project's core documentation by refining the _index.md file within the concepts section. The changes involve removing references to deprecated or moved concept pages and introducing links to newly added documentation for 'Ingress' and 'Benchmarks', ensuring the documentation remains current and accurately reflects the available concepts.
Highlights
- Documentation Cleanup: Removed outdated or irrelevant links and descriptions for 'Dedicated AI Cluster' and 'Dedicated AI Cluster Profile' from the main concepts index page.
- New Concept Introductions: Added new sections and links to 'Ingress' and 'Benchmarks' concept documentation pages, expanding the range of topics covered in the concepts overview.
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 updates the concepts documentation by removing sections for Dedicated AI Cluster and Dedicated AI Cluster Profile, and adding new sections for Ingress and Benchmarks. While the reorganization is logical, the new link to the Benchmarks documentation is broken because the target file is missing. This should be addressed before merging.
| ### [Benchmarks](/ome/docs/concepts/benchmarks) | ||
|
|
||
| OME integrates with the latest GenAI-Bench benchmarks to provide real-time benchmarking capabilities for AI models. | ||
| This section provides an overview of the GenAI-Bench benchmarks, how they work, and how to use them with OME. |
There was a problem hiding this comment.
This change introduces a new 'Benchmarks' section, but the link /ome/docs/concepts/benchmarks appears to be broken. Based on the file list provided for review, the corresponding content file site/content/en/docs/concepts/benchmarks.md seems to be missing.
A broken link prevents users from accessing important information. Given this pull request aims to fix site references, it's crucial to ensure all new links are valid.
Could you please either:
- Add the
benchmarks.mdcontent file to this pull request. - Remove this section for now if the content is not yet ready.
No description provided.