Skip to content

Conversation

Michaeloye
Copy link

@Michaeloye Michaeloye commented Jul 31, 2025

Update prompting-debugging.mdx

Refactor AI response prompt example for proper MDX rendering under Full System Review (Codebase Audit) section.

At the moment this is how the markdown renders on the doc page:

image

You would notice the listing is misleading, That is what this pull request aims fix.

Thank you.

Refactor AI response prompt example for proper MDX rendering under Full System Review (Codebase Audit) section.
Copy link

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

Summary of Changes

Hello @Michaeloye, 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 rendering accuracy of an AI response example in the prompting-debugging.mdx documentation. The primary goal is to refactor the markdown syntax to ensure the example displays correctly as a numbered list, enhancing readability and clarity for users.

Highlights

  • Documentation Refinement: Corrected the markdown syntax for an AI response example within the 'Full System Review (Codebase Audit)' section of prompting-debugging.mdx to ensure it renders as a proper numbered list.
  • MDX Formatting Fix: Addressed rendering issues caused by incorrect characters and mixed list formatting in the AI response example, which previously resulted in a 'misleading listing'.
  • File Hygiene: Added a missing newline character at the end of the prompting-debugging.mdx file for better file formatting consistency.
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 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 or fill out our survey 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

  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

@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 successfully refactors a markdown list to fix a rendering issue in prompting-debugging.mdx, making the example AI response much clearer. My review includes a suggestion to correct a minor typographical error in a quotation mark. Additionally, a newline has been correctly added to the end of the file, which is good practice.

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.

1 participant