fix: prevent MDX build failure in OpenAI conformance report #4737
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
gyliu513
requested review from
ashwinb,
bbrowning,
cdoern,
ehhuang,
franciscojavierarceo,
leseb,
mattf and
raghotham
as code owners
meta-cla
bot
added
the
CLA Signed
franciscojavierarceo
approved these changes
Jan 26, 2026
cdoern
approved these changes
Jan 26, 2026
Issue Docusaurus build fails when rendering `docs/docs/api-openai/conformance.mdx` because the generated MDX uses inline `<details><summary>` tags, which MDX treats as an inline paragraph and throws an end-tag mismatch error. Solution Update `scripts/generate_openai_coverage_docs.py` to emit `<details>` and `<summary>` on separate lines (block-level), then regenerate `conformance.mdx` with the new formatting so MDX parses correctly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this PR do?
Issue
docs/docs/api-openai/conformance.mdxbecause the generated MDX uses inline<details><summary>tags, which MDX treats as an inline paragraph and throws an end-tag mismatch error.Solution
scripts/generate_openai_coverage_docs.pyto emit<details>and<summary>on separate lines (block-level), then regenerateconformance.mdxwith the new formatting so MDX parses correctly.Fixed #4736
@leseb
Test Plan