fix: fix MDX syntax errors in 11 docs pages (#251)#258
Open
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
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.
Summary
Fixes MDX syntax errors in 11 docs pages so Mintlify can parse and render them, removing them from
.mintignore.Files fixed
community/users.mdx{: .external}link classconcepts/build-files.mdx{: .external}, devsite nav tableconcepts/dependencies.mdx{bare braces in<pre>,importat col 0, inline<pre>, devsite nav tableconcepts/labels.mdx{{ "<var>" }}template → backtick, devsite nav tableconcepts/visibility.mdx{#...}GitHub heading anchorcontribute/search.mdx{:#...}devsite anchors,<br>→<br />,\</td>→\</td>docs/cc-toolchain-config-reference.mdx{:#...}anchors,<col>→ self-closing, inline<pre>, multi-line<td>, 4-space code block with<inc0>docs/user-manual.mdx{:#...}anchors,{{ }}templates,${}shell var escaping, inline<pre>, stray</p>extending/config.mdx{:#...}anchors, bare{String:Object}dict literalextending/platforms.mdx{:#...}anchors,{: .external}Also adds
upstream/**to.mintignoreto exclude the git submodule frommint validatescans.Remaining in
.mintignorereference/be/**,rules/lib/**) — needdocs2mdx.pyfix upstreamquery/language.mdx,reference/glossary.mdx,reference/test-encyclopedia.mdx,reference/flag-cheatsheet.mdx, fwe@ files) — will be addressed after that PR merges*/community/roadmaps-build-api.mdx,*/external/advanced.mdx,*/query/cquery.mdx)Test plan
mint validatepasses with zero parsing errors locallyPartial fix for #251