-
Notifications
You must be signed in to change notification settings - Fork 1
feat(docs): improve getting started page #164
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 @b-long, 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 'Getting Started' documentation by improving the clarity and flow of instructions for setting up the platform locally. It reorders key steps, provides a more guided experience for using Docker Compose, and refines specific environment configurations, ensuring a smoother onboarding process for new users. 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 significantly improves the 'Getting Started' documentation by reorganizing the steps into a more logical flow and clarifying the instructions for running the platform with Docker, especially for Apple M4 users. The changes make the guide easier to follow. I have one suggestion to improve code maintainability by replacing an inline style with a CSS class.
|
This looks more user-friendly and reflects tests Brian and I performed together with successful results. |
Cleans up the "Getting Started" page a bit, so that it's more approachable for end-users.
Changes Made
Before
After