fix(docs): fix formatting issues in dev docs #1319
Merged
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
davelinke
force-pushed
the
design-docs-ux-writing
branch
from
a064329 to
c328b3b
Compare
chanceaclark
approved these changes
Dec 12, 2023
chanceaclark
changed the title
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.
What?
Corrected MDX to preserve table and list format on certain files.
Why?
After the implementation of linting, the mix of markdown and react wrappers caused lists and tables o loose format and appear as misformatted text, this PR fixes it.
Screenshots/Screen Recordings
The compiled MDX in the dev-documentation repo should look like these screenshots:
https://www.figma.com/file/XWxcx6FLg1tGevfxkqFLcA/UX-writing-guide---redlining?type=whiteboard&node-id=0-1&t=ZPcrMfN0LDd5x1q1-0
Testing/Proof
No tests associated to this functionality on this repository as it's going to feed the dev-documentation build.