Skip to content

[docs/dart] Fix rendering of various lists#246

Open
parlough wants to merge 1 commit intogenkit-ai:mainfrom
parlough:fix/dart-docs-lists
Open

[docs/dart] Fix rendering of various lists#246
parlough wants to merge 1 commit intogenkit-ai:mainfrom
parlough:fix/dart-docs-lists

Conversation

@parlough
Copy link
Copy Markdown

@parlough parlough commented Mar 16, 2026

This fixes various ordered and unordered lists in the Dart documentation which were being parsed as multiple separate lists due to inaccurate nesting of content.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 addresses a common documentation formatting issue where code blocks nested within ordered and unordered lists were not rendering correctly. By adjusting the markdown syntax to include blank lines and appropriate indentation, the changes ensure that these code examples are accurately parsed and displayed as part of their respective list items, significantly enhancing readability and consistency across the Dart documentation.

Highlights

  • Documentation Formatting: Improved the rendering of code blocks within ordered and unordered lists across several Dart documentation files.
  • Markdown Consistency: Standardized the markdown syntax for nested code examples by adding blank lines and proper indentation, ensuring correct parsing and display.
Changelog
  • src/content/docs/docs/deployment/any-platform.mdx
    • Adjusted markdown formatting for code blocks within ordered lists.
    • Corrected indentation for nested list items.
  • src/content/docs/docs/deployment/cloud-run.mdx
    • Adjusted markdown formatting for code blocks within ordered lists.
  • src/content/docs/docs/frameworks/shelf.mdx
    • Adjusted markdown formatting for code blocks within ordered lists.
  • src/content/docs/docs/integrations/google-genai.mdx
    • Adjusted markdown formatting for a code block within an ordered list.
  • src/content/docs/docs/integrations/vertex-ai.mdx
    • Adjusted markdown formatting for code blocks within lists.
    • Corrected indentation for nested list items.
  • src/content/docs/docs/local-observability.mdx
    • Adjusted markdown formatting for a code block within an ordered list.
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
Copy Markdown
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 addresses markdown rendering issues in several Dart documentation files. The changes correctly adjust indentation and spacing for ordered and unordered lists, particularly for code blocks and nested content within list items. These fixes ensure that the lists are parsed and rendered correctly as single, continuous lists, improving the readability and structure of the documentation. The changes are accurate and effectively resolve the described rendering problems.

Copy link
Copy Markdown
Collaborator

@abdallahshaban557 abdallahshaban557 left a comment

Choose a reason for hiding this comment

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

LGTM

@parlough parlough force-pushed the fix/dart-docs-lists branch from 14045b1 to df02eda Compare March 18, 2026 10:23
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.

2 participants