Skip to content

fix: render markdown properly in development guide#711

Merged
eliasecchig merged 1 commit intomainfrom
fix/docs-markdown-rendering
Jan 19, 2026
Merged

fix: render markdown properly in development guide#711
eliasecchig merged 1 commit intomainfrom
fix/docs-markdown-rendering

Conversation

@eliasecchig
Copy link
Collaborator

Summary

  • Fix unrendered markdown in development guide
  • Remove code-group wrapper that prevented bold text from rendering

Fixes #703

Remove code-group wrapper that prevented bold text from rendering.
Fixes #703
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @eliasecchig, 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 resolves a markdown rendering anomaly within the development-guide.md file. The primary change involves removing a code-group wrapper that was inadvertently preventing bold text from being displayed correctly. By simplifying the formatting, the guide's instructions for Python and Go projects are now properly rendered, enhancing readability and ensuring the documentation appears as intended.

Highlights

  • Markdown Rendering Fix: Addressed an issue where markdown was not rendering correctly in the development guide, specifically preventing bold text from displaying as intended.
  • Code-Group Wrapper Removal: Removed the code-group wrapper that was causing the markdown rendering problems in the development-guide.md file.
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.

@eliasecchig eliasecchig merged commit 2989f8d into main Jan 19, 2026
34 checks passed
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 aims to fix a markdown rendering issue in the development guide by removing a code-group container. While this successfully fixes the rendering of bold text, it also removes the tabbed user interface that grouped Python and Go project information. I've provided a suggestion to use markdown as the language specifier within the code-group. This should correct the rendering issue while preserving the original tabbed layout, offering a better user experience.

Comment on lines +67 to 77
**Python Projects**

1. **Prototype:** Use notebooks in `notebooks/` for rapid experimentation
2. **Integrate:** Edit `app/agent.py` to incorporate your logic
3. **Test:** Run the interactive playground with hot-reloading
```

```text [Go Projects]
**Go Projects**

1. **Integrate:** Edit `agent/agent.go` to add tools and logic
2. **Test:** Run the interactive playground to test changes
```
:::

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While your change fixes the issue of bold text not rendering, it removes the tabbed code-group layout, which was a nice way to organize the information for Python and Go projects. You can likely fix the rendering issue while keeping the tabs by changing the language identifier from text to markdown. This should instruct VitePress to parse the markdown within the code blocks.

Suggested change
**Python Projects**
1. **Prototype:** Use notebooks in `notebooks/` for rapid experimentation
2. **Integrate:** Edit `app/agent.py` to incorporate your logic
3. **Test:** Run the interactive playground with hot-reloading
```
```text [Go Projects]
**Go Projects**
1. **Integrate:** Edit `agent/agent.go` to add tools and logic
2. **Test:** Run the interactive playground to test changes
```
:::
::: code-group
```markdown [Python Projects]
1. **Prototype:** Use notebooks in `notebooks/` for rapid experimentation
2. **Integrate:** Edit `app/agent.py` to incorporate your logic
3. **Test:** Run the interactive playground with hot-reloading
1. **Integrate:** Edit `agent/agent.go` to add tools and logic
2. **Test:** Run the interactive playground to test changes

:::

enriquekalven pushed a commit to enriquekalven/agent-starter-pack that referenced this pull request Feb 7, 2026
…rm#711)

Remove code-group wrapper that prevented bold text from rendering.
Fixes GoogleCloudPlatform#703
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.

docs: Development Guide instructions are showing up as unrendered markdown

1 participant