Skip to content

Conversation

@b-long
Copy link
Contributor

@b-long b-long commented Dec 22, 2025

Cleans up the "Getting Started" page a bit, so that it's more approachable for end-users.

Changes Made

  1. Reordered sections for logical flow:
    • Update /etc/hosts → Get docker-compose.yaml → Start platform → Trust certificates
  2. Added download button for docker-compose.yaml with save instructions
  3. Added startup commands
  4. Moved certificate trust section after startup

Before

image

After

image

@b-long b-long requested a review from a team as a code owner December 22, 2025 14:13
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • Documentation Structure: The 'Update /etc/hosts' section has been reordered to appear before 'Getting the Platform Running' for a more logical setup flow.
  • Docker Compose Workflow: New sub-sections 'Save the Docker Compose File' and 'Start the Platform' have been added, along with a convenient download button for the docker-compose.yaml file, to streamline the setup process.
  • Apple M4 Chip Support: Instructions for Apple M4 chip users regarding the JAVA_OPTS_APPEND environment variable have been clarified and integrated directly into the docker compose command example for better usability.
  • Certificate Extraction Clarity: The wording for extracting self-signed certificates has been made more explicit to guide users through the process.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

@rzubi-virtru
Copy link

This looks more user-friendly and reflects tests Brian and I performed together with successful results.

@b-long b-long enabled auto-merge (squash) December 22, 2025 14:55
@b-long b-long merged commit 7196a9a into main Dec 22, 2025
4 checks passed
@b-long b-long deleted the feat/DSPX-2026--update-getting-started branch December 22, 2025 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants