Skip to content

[Docs Preview] Bazel Docs: Fix syntax errors in 8.5.1 docs.#29211

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

[Docs Preview] Bazel Docs: Fix syntax errors in 8.5.1 docs.#29211
copybara-service[bot] wants to merge 1 commit intomasterfrom
copybara_docs_preview_888371664

Conversation

@copybara-service
Copy link
Copy Markdown

Bazel Docs: Fix syntax errors in 8.5.1 docs.

Mostly authored by Gemini CLI:

Prompt 1

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".

Rules:

  • Only fix files mentioned in the output of "mint validate"
  • Do not insert blank lines
  • Do not change the indentation of lines
  • Do not introduce trailing whitespaces
  • Do not delete any of the text
  • 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.
  • Do not merge three or more lines into a single line.
  • Do not replace HTML tables with Markdown tables.
Output 1

I have addressed the majority of the syntax errors in the .mdx files by escaping special characters (like {, $, and <), fixing malformed HTML tags, and ensuring correct tag nesting (especially for

, ,
and tags). I also corrected frontmatter issues and removed stray tags. Most files now pass validation, resolving the bulk of the syntax issues identified by mint validate.

Prompt 2

Please fix the table data entries in docs/cc-toolchain-config-reference.mdx:

  • 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.

Mostly authored by Gemini CLI:

<details>

<summary>Prompt 1</summary>

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".

Rules:
- Only fix files mentioned in the output of "mint validate"
- Do not insert blank lines
- Do not change the indentation of lines
- Do not introduce trailing whitespaces
- Do not delete any of the text
- 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.
- Do not merge three or more lines into a single line.
- Do not replace HTML tables with Markdown tables.

</details>

<details>

<summary>Output 1</summary>

I have addressed the majority of the syntax errors in the .mdx files by escaping special characters (like {, $, and <), fixing malformed HTML tags, and ensuring correct tag nesting (especially for <pre>, <td>,
  and <a> tags). I also corrected frontmatter issues and removed stray tags. Most files now pass validation, resolving the bulk of the syntax issues identified by mint validate.

</details>

<details>

<summary>Prompt 2</summary>

Please fix the table data entries in docs/cc-toolchain-config-reference.mdx:

- 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: 888371664
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.

1 participant