chore(tooling): add mdx to prettier and cspell, ignore archived docs - #4624
Open
thetaPC wants to merge 1 commit into
Open
chore(tooling): add mdx to prettier and cspell, ignore archived docs#4624thetaPC wants to merge 1 commit into
thetaPC wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Issue URL: internal
What is the current behavior?
Prettier and cspell both only look at
.md, so the tracked.mdxfiles in the repo have never been formatted or spellchecked.docs/deployment/play-store.mdxand its v7 copy have drifted as a result.Separately, both tools run over
versioned_docs/version-v5andversioned_docs/version-v6. Those versions are not listed inversions.json, so Docusaurus never builds them. They are served from standalone deployments listed inversionsArchived.json, which means tooling is formatting and spellchecking 696 files that ship from somewhere else.What is the new behavior?
.mdxis treated as a first class doc extension by both tools, and archived versions are excluded from both.prettierglob now includesmdxspellcheckglob now includesmdx.prettierignoreandcspell.jsonboth skipversioned_docs/version-v5andversioned_docs/version-v6.mdxfiles, which are now in scopeDoes this introduce a breaking change?
Other information
This is groundwork for migrating our docs from
.mdto.mdx, which Docusaurus recommends ahead of v4.