Skip to content

[Docs Preview] Bazel Docs: Fix syntax errors in 8.6 docs.#29293

Draft
copybara-service[bot] wants to merge 1 commit intomasterfrom
copybara_docs_preview_899604512
Draft

[Docs Preview] Bazel Docs: Fix syntax errors in 8.6 docs.#29293
copybara-service[bot] wants to merge 1 commit intomasterfrom
copybara_docs_preview_899604512

Conversation

@copybara-service
Copy link
Copy Markdown

Bazel Docs: Fix syntax errors in 8.6 docs.

Fixes #28930

Prompt

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 and tags are self-closing.
  • Fix the escaped tags - replace {{ "" }} with (same for ).
  • Replace
     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 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.

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create .mdx docs for Bazel 8.6

1 participant