Backport of docs: Fix display issue with bullets and code into stable-website #3335
Conversation
This file contains 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
hc-github-team-secure-boundary
force-pushed
the
backport/dheath-fix-spacing-bullets/code/specially-meet-skink
branch
from
6dc4cb8
to
fd58a8a
Compare
hc-github-team-secure-boundary
deleted the
backport/dheath-fix-spacing-bullets/code/specially-meet-skink
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Backport
This PR is auto-generated from #3333 to be assessed for backporting due to the inclusion of the label backport/website.
The below text is copied from the body of the original PR.
When the text inside a bullet begins with code, our renderer changes the text to a link. The link doesn't go anywhere when you click it, creating a bad user experience:
I discussed it with the DevDot team, and this is a limitation of our system; there is no fix for it at this time.
I thought I figured out a workaround by adding the HTML entity for a space (
 ) before the text for the bullet. The extra space prevented the code from rendering as a link, and Markdown ignored it as a duplicate space. This worked great on my local machine and in Vercel previews:However, when these updates were published, they did not render the same way in our production environment. The extra space is turning those bullet points into code blocks:
This user experience is worse than having links that don't go anywhere. So this PR gets rid of the extra spaces and puts everything back to our standard format.