Skip to content

Agent skill sync with docs: add MDX component reference - #7191

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ff273622
Open

Agent skill sync with docs: add MDX component reference#7191
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ff273622

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Sync the canonical Mintlify agent skill with English documentation changes from the last review window (2026-08-28 to 2026-08-29).

Changes

  • reference/components.md: add a section for the new <MDX> component (conditional Markdown in JSX expressions, block form, indentation stripping, TOC exclusion, and the 8-level nesting / 500-fragment limits), from components/mdx.mdx (Update from code changes: document the MDX component #7166).
  • reference/components.md: note that the <RequestExample>/<ResponseExample> sidebar panel has a fixed, non-configurable width and to use a regular code block or <CodeGroup> for full-width examples, from components/examples.mdx (Fill gaps from assistant conversations: card icon CSS and example width #7170).
  • SKILL.md: add MDX to the components reference index and update the component count to 26.

Reviewed but not skill-relevant: preview deployment auth gating (#7181), bring your own model (#7174), MDX VS Code extension updates (#7167), card icon CSS selectors (#7170), changelog and translation-only commits.

Validation

npm test, npm run check, npm run build, and git diff --check all passed. The existing sync workflow will distribute the canonical skill to plugin repositories after merge.


Note

Low Risk
Markdown-only agent skill sync; no auth, APIs, or build pipeline changes in this diff.

Overview
Updates the canonical Mintlify agent skill so coding agents match recent English docs—no product or runtime code changes.

reference/components.md adds a full <MDX> section: using the wrapper for Markdown inside JSX conditionals, block-form parsing, indentation stripping, TOC exclusion, and build limits (8 nesting levels, 500 fragments). It also documents that <RequestExample> / <ResponseExample> sidebar panels have a fixed width and points authors to main-column code blocks or <CodeGroup> for full-width examples.

SKILL.md lists MDX in the components reference index and bumps the documented component count from 25 to 26.

Reviewed by Cursor Bugbot for commit ddfc48b. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 29, 2026, 4:11 PM

@mintlify

mintlify Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 29, 2026, 4:09 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

0 participants