[Docs Preview] Bazel Docs: Fix syntax errors in 8.6 docs.#29293
Draft
copybara-service[bot] wants to merge 1 commit intomasterfrom
Draft
[Docs Preview] Bazel Docs: Fix syntax errors in 8.6 docs.#29293copybara-service[bot] wants to merge 1 commit intomasterfrom
copybara-service[bot] wants to merge 1 commit intomasterfrom
Conversation
Fixes #28930 <details> <summary>Prompt</summar> You're an experienced tech writer. Your task is to fix all remaining syntax errors in .mdx files in the current directory. You can find syntax errors by running "mint validate". General rules: - Only fix files mentioned in the output of "mint validate". - Do not insert blank lines and do not introduce trailing whitespaces. - Do not delete any of the text. - Do not merge three or more lines into a single line. - Do not replace HTML tables with Markdown tables. How to fix errors: - Remove any text before the YAML frontmatter. - Unexpected symbols outside of code blocks (mostly { and <) can be fixed by surrounding the snippet with backticks. - Make sure that <img> and <col> tags are self-closing. - Fix the escaped <var> tags - replace {{ "<var>" }} with <var> (same for <sub>). - Replace <pre> blocks with Markdown fenced code blocks (three backticks). - Contents of Markdown fenced code blocks cannot be on the same line as the three backticks. - Replace HTML comments with JSX comments. - For <td> errors: If the <td> element and the text are on a single line, make sure that the matching </td> is on the same line. If the text spans multiple lines, make sure that both <td> and </td> have their own lines, i.e. they are not on the same line as the text. </details> PiperOrigin-RevId: 899604512
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.
Bazel Docs: Fix syntax errors in 8.6 docs.
Fixes #28930
Prompt- Only fix files mentioned in the output of "mint validate".
- Do not insert blank lines and do not introduce trailing whitespaces.
- Do not delete any of the text.
- Do not merge three or more lines into a single line.
- Do not replace HTML tables with Markdown tables.
- Remove any text before the YAML frontmatter.
- Unexpected symbols outside of code blocks (mostly { and <) can be fixed by surrounding the snippet with backticks.
- Make sure that
and tags are self-closing.
- Fix the escaped tags - replace {{ "" }} with (same for ).
- Replace
- Contents of Markdown fenced code blocks cannot be on the same line as the three backticks.
- Replace HTML comments with JSX comments.
- For errors: If the element and the text are on a single line, make sure that the matching is on the same line. If the text spans multiple lines, make sure that both and have their own lines, i.e. they are not on the same line as the text.
You're an experienced tech writer. Your task is to fix all remaining syntax errors in .mdx files in the current directory. You can find syntax errors by running "mint validate".
General rules:
How to fix errors: