fix(ci): add MDX safety check for non-self-closing img tags#620
Merged
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
mchmarny
previously approved these changes
Apr 20, 2026
This was referenced Apr 20, 2026
Closed
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
pdmack
added a commit
to pdmack/topograph
that referenced
this pull request
Apr 20, 2026
Extend the grep to cover fern/ and *.mdx in addition to docs/*.md. Add comments explaining the inline and single-line choices. Matches the pattern settled on in NVIDIA/NVSentinel#1215 and NVIDIA/aicr#620. Signed-off-by: Pete MacKinnon <pmackinnon@nvidia.com>
4 tasks
pdmack
added a commit
to pdmack/topograph
that referenced
this pull request
Apr 20, 2026
Extend the grep to cover fern/ and *.mdx in addition to docs/*.md. Add comments explaining the inline and single-line choices. Matches the pattern settled on in NVIDIA/NVSentinel#1215 and NVIDIA/aicr#620. Signed-off-by: Pete MacKinnon <pmackinnon@nvidia.com>
dmitsh
pushed a commit
to NVIDIA/topograph
that referenced
this pull request
Apr 20, 2026
Extend the grep to cover fern/ and *.mdx in addition to docs/*.md. Add comments explaining the inline and single-line choices. Matches the pattern settled on in NVIDIA/NVSentinel#1215 and NVIDIA/aicr#620. Signed-off-by: Pete MacKinnon <pmackinnon@nvidia.com>
mchmarny
approved these changes
Apr 20, 2026
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
2 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.
Summary
Add a grep-based MDX safety step to
fern-docs-ci.yamlthat catches non-self-closing<img>tags before merge.Motivation / Context
Fixes: #619
Related: N/A
Type of Change
Component(s) Affected
docs/,examples/)Implementation Notes
fern checkvalidates Fern configuration only — it does not parse MDX content. Non-self-closing<img>tags (e.g.<img src="foo.png">) passfern checkbut causefern generateto fail withUnexpected closing tag </p>. The new step greps for this pattern and fails the job with an actionable error message before merge.Root-caused from a live failure in NVIDIA/topograph#281.
Testing
Step runs on all PRs touching
docs/**orfern/**. No existing docs files contain non-self-closing<img>tags.Risk Assessment
Rollout notes: N/A
Checklist
git commit -S)