feat: Improve readability of nested lists #12593
Merged
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
Previously, any nested lists would be rendered as follows:
```
1. Main item
1. Sub-item
1. Sub-sub-item
2. Another sub-sub-item
2. Another sub-item
2. Another main item
```
Reading the above nested list is difficult, since the reader needs to keep track of the indentation in order to tell whether an item is a main item, sub-item, or sub-sub-item.
This PR changes the numbering format for sub-items and sub-sub-items to make the item types clearer. The example above would now render as:
```
1. Main item
a. Sub-item
i. Sub-sub-item
ii. Another sub-sub-item
b. Another sub-item
2. Another main item
```
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 70 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
chargome
approved these changes
Feb 5, 2025
Member
chargome
left a comment
chargome
left a comment
There was a problem hiding this comment.
Looks better this way, thanks for adding!
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Previously, any nested lists would be rendered as follows:
Reading the above nested list is difficult, since the reader needs to keep track of the indentation in order to tell whether an item is a main item, sub-item, or sub-sub-item.
This PR changes the numbering format for sub-items and sub-sub-items to make the item types clearer. The example above would now render as:
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES