-
Notifications
You must be signed in to change notification settings - Fork 0
docs: remove prerequisites section from LLM model demo for clarity #62
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
Summary of ChangesHello @KUASWoodyLIN, 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 focuses on improving the readability and conciseness of the Large Language Model (LLM) deployment guide. By removing the 'Prerequisites' section, the documentation now flows more directly into the core deployment steps, ensuring users can quickly grasp and implement the instructions without encountering potentially redundant or distracting information. 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
|
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
This pull request simplifies the LLM model demo documentation by removing a redundant 'Prerequisites' section. This is a positive change for clarity. However, it also removes the specific Python version requirement. My review includes a comment to ensure this important detail is not lost and is moved to the correct location in the document.
I am having trouble creating individual review comments. Click here to see my feedback.
src/content/docs/demos/04-llm-model.mdx (10-20)
While removing this redundant 'Prerequisites' section is a good change for clarity, it also removes the Python version requirement (3.8+). This information seems important and should be added to the Aside block for prerequisites under the 'Test with Python' section to ensure users have the correct environment setup information.
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.
Pull request overview
This PR removes the standalone Prerequisites section from the LLM model demo documentation to improve clarity by consolidating prerequisite information closer to where it's actually needed.
Key Changes:
- Removed the top-level Prerequisites section that appeared at the beginning of the guide
- Prerequisite information (Python and
requestslibrary) remains available in an Aside component within the "Test with Python" section
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.