Skip to content

Allow safe connector MDX formatting#80

Merged
gontzess merged 1 commit into
mainfrom
gontzess/shared-mdx-validation-fixtures
May 19, 2026
Merged

Allow safe connector MDX formatting#80
gontzess merged 1 commit into
mainfrom
gontzess/shared-mdx-validation-fixtures

Conversation

@gontzess

@gontzess gontzess commented May 19, 2026

Copy link
Copy Markdown
Contributor

Why
Connector docs validation was flagging valid docs syntax, including comment-only MDX expressions, table <br/> line breaks, CardGroup, and indented code placeholders. This keeps the PR check aligned with docs syntax we expect while preserving rejects for executable MDX and unsafe URLs.

What this changes

  • Allows comment-only MDX expressions, safe <br/> elements, and CardGroup.
  • Adds a shared fixture file for cases that should match registry validation.
  • Adds reject fixtures for reviewed escape/comment bypass cases so the workflow validator pins the same contract as the registry validator.
  • Runs the fixture contract from the Node linter tests.

Validation:

  • npm test in tools/mdx-lint: 30 passed.
  • Live connector-doc compatibility scan: 233 valid, 1 real doc issue, 71 missing docs.

Rollout:

  • After merge, connector repos need to consume this workflow ref/tag before PR checks see the updated policy.

@gontzess
gontzess marked this pull request as ready for review May 19, 2026 00:35
@gontzess
gontzess force-pushed the gontzess/shared-mdx-validation-fixtures branch from 2b6abbc to 39c379b Compare May 19, 2026 00:50
@gontzess
gontzess merged commit d2a4189 into main May 19, 2026
2 checks passed
@gontzess
gontzess deleted the gontzess/shared-mdx-validation-fixtures branch May 19, 2026 00:51
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