Skip to content

Docs: remove fixed docs from list broken mdx files#181

Closed
kapunahelewong wants to merge 2 commits intobazel-contrib:mainfrom
kapunahelewong:broken-files-update
Closed

Docs: remove fixed docs from list broken mdx files#181
kapunahelewong wants to merge 2 commits intobazel-contrib:mainfrom
kapunahelewong:broken-files-update

Conversation

@kapunahelewong
Copy link
Copy Markdown

Removes the files I updated in bazelbuild/bazel#28195. When I confirm that was done correctly, I can change this from a draft PR.

@promptless
Copy link
Copy Markdown
Contributor

promptless bot commented Jan 22, 2026

✅ No documentation updates required.

@promptless
Copy link
Copy Markdown
Contributor

promptless bot commented Jan 23, 2026

✅ No documentation updates required.

@alan707
Copy link
Copy Markdown
Collaborator

alan707 commented Mar 2, 2026

Hey @kapunahelewong! I finally got around to testing these files as part of PR #206 (switching to gen_mdx_reference_docs). Good news: contribute/docs-style-guide.mdx is now fixed and has been removed from .mintignore there. Unfortunately, concepts/build-files.mdx, concepts/dependencies.mdx, and concepts/labels.mdx still fail MDX parsing. It looks like the upstream fix in bazelbuild/bazel#28195 did not fully resolve those three. The errors are bare {..} dict literals in prose which MDX tries to parse as JSX expressions. The fix is to escape the curly braces in the upstream source (e.g. {name: value}).

Since this PR modifies copy-upstream-docs.sh, which is being removed by PR #235, it might make sense to close this one in favor of #206, which already tracks the current broken/fixed state in .mintignore.

Thoughts?

Copy link
Copy Markdown
Collaborator

@alan707 alan707 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see comment, we should fix the parsing errors and we can test them after #206 lands.

@kapunahelewong
Copy link
Copy Markdown
Author

Ah got it. Thank you for the details, @alan707. I'll go ahead and close this one. So the fixes should be like this (contingent on #206)? bazelbuild/bazel#28866

@alan707
Copy link
Copy Markdown
Collaborator

alan707 commented Mar 4, 2026

@kapunahelewong yes, exactly! You can make the changes directly on bazelbuild/bazel. Hopefully we can land the PR tomorrow after the meeting

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.

2 participants