fix: render markdown properly in development guide#711
Conversation
Remove code-group wrapper that prevented bold text from rendering. Fixes #703
Summary of ChangesHello @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 Highlights
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.
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.
| **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 | ||
| ``` | ||
| ::: | ||
|
|
There was a problem hiding this comment.
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.
| **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:::
…rm#711) Remove code-group wrapper that prevented bold text from rendering. Fixes GoogleCloudPlatform#703
Summary
Fixes #703