Fix a bunch of lettered lists and alignment#33709
Merged
Conversation
github-actions
bot
added
Architecture
Contributor
maycmlee
approved these changes
Jan 7, 2026
fuzzybinary
approved these changes
Jan 7, 2026
Member
fuzzybinary
left a comment
fuzzybinary
left a comment
There was a problem hiding this comment.
Super minor nit about the indentation within code blocks. It's possible it doesn't affect rendering though and if that's the case it can be ignored.
| {{% /tab %}} | ||
| {{% tab "Java" %}} | ||
| ```java | ||
| public class SampleApplication extends Application { |
Member
There was a problem hiding this comment.
I think sometimes these code blocks are getting extra indentation, and sometimes they're not. I'm not sure if it affects rendering but I thought I would point it out.
For example, this java block is indented one level above the "```java" whereas the one below with kotlin isn't.
It looks like prior all code is indented to the same level as the opening block.
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
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.
What does this PR do? What is the motivation?
This PR looks large, but it should be easy to review! I did it because I noticed that there were instances of nested lists that were formatted like
Most commonly, using these lettered lists caused issues like the list items all appearing on a single line, or writers having to put in rogue
<br /tags to make them appear as expected.The formatting we need for lists to be rendered correctly looks like
So I went through and updated them. While I was at it, I also made a handful of minor typo/punctuation edits and whitespace edits to make code blocks align with those list items, which now had their own proper alignments! I know you're as thrilled as I am about this!
As always, I checked the changes I made in my local build while I did them. Your mission, should you choose to accept it, is to check to ensure I didn't delete something dumb or change what I shouldn't have, but overall it should be fairly easy to spot check. Let me know if you have any questions!
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes