docs: fix list rendering in contribution guide part of docs #1987
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR fixes markdown list rendering issues in the contribution guide documentation. The changes ensure proper list formatting by adding empty lines before lists that follow plain text and adjusting indentation for nested lists.
- Adds empty lines before lists to ensure proper markdown rendering
- Fixes nested list indentation to use 4 spaces instead of 2
- Updates multiple documentation files in the contributor guide section
Reviewed Changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/contributor-guide/maintainer.mdx | Adds empty line before nested list under "Pay special attention to" |
| website/docs/contributor-guide/how-ag2-works/generate-reply.mdx | Adds empty lines before multiple nested lists in the generate_reply process |
| website/docs/contributor-guide/contributing.mdx | Adds empty lines before various lists throughout the contributing guide |
| website/docs/contributor-guide/building/creating-an-agent.mdx | Adds empty lines before pros/cons lists and documentation requirements |
| website/docs/contributor-guide/building/creating-a-tool.mdx | Adds empty line before documentation requirements list |
priyansh4320
approved these changes
Aug 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
Fix list rendering in contribution guide part of docs:
Related issue number
Relevant to #1985, but this issue not quite about that particular problem.
Checks