Skip to content

Update & deprecate from code: className prop and Markdown titles - #7180

Closed
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/caec382d
Closed

mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/caec382d

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents two newly shipped MDX authoring features: an optional className prop on more components, and inline Markdown formatting support in component title props.

Changes

  • Added a className property to the prop tables for accordions, callouts, steps, tabs, expandables, tooltips, param/response fields, panel, and color pages, matching the existing style used on Badge, GitHub card, and Icon pages.
  • Corrected the callouts page, which said typed callouts accept only children.
  • Noted that title props on Accordion, Card, Color.Row, Step, Tab, and Tile support inline Markdown such as bold, italic, and inline code.
  • Mirrored all edits into the Spanish, French, and Chinese translations.

Context

Recent releases added an optional className prop (merged onto each component's outer element) to most content components, and made component titles compile inline Markdown. Other changes in the review window were either already documented (the <MDX> component, admin-only MCP publishing) or not documented surfaces (dashboard runs-feed redesign, granular notification preferences). One verified but undocumented change: agent runs on deployments using a self-provided OpenRouter key are now billed at half the standard credit rate; the bring-your-own-key setting itself is entitlement-gated and has no docs page, so this was left out pending a decision on documenting BYOK.


Note

Medium Risk
Documentation-only, but the Quickstart page gains visible placeholder content that would ship to a primary onboarding doc; the MDX extension page also removes explanatory intro copy that may have been unintentional.

Overview
Updates Mintlify component reference docs (English plus es, fr, zh) to match recently shipped MDX behavior: optional className on accordions, callouts (including typed callouts), steps/tabs, expandables, tooltips, param/response fields, panel, and color components, and inline Markdown in title on Accordion, Card, Color.Row, Step, Tab, and Tile. Adds a Properties section for Panel where it was missing and fixes callout copy that incorrectly limited typed callouts to children only.

cli/mdx-extension.mdx reformats frontmatter keywords, drops the opening paragraph that described autocomplete/diagnostics/language support, and lightly reformats troubleshooting accordions. quickstart.mdx also switches keywords to a YAML list, tightens whitespace in the agent setup steps, and introduces a stray markdown table (diego) and favicon image at the top of the page that look like accidental test content rather than intentional quickstart changes.

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

Mintlify

2 threads from 1 user in Mintlify

Review in Mintlify

@mintlify

mintlify Bot commented Aug 28, 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 28, 2026, 6:25 PM

@mintlify

mintlify Bot commented Aug 28, 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 28, 2026, 6:19 PM

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

- Updated cli/mdx-extension.mdx

Mintlify-Source: dashboard-editor
- Updated quickstart.mdx

Mintlify-Source: dashboard-editor

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 2afa826. Configure here.

Comment thread quickstart.mdx
| | | |
| | | |

![Favicon](/favicon.ico "Favicon")

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Accidental table and image in quickstart

High Severity

An empty markdown table headed diego and a favicon.ico image were inserted at the top of quickstart.mdx, above the page intro. They look like leftover editor test content and would render for every visitor on the getting-started page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 2afa826. Configure here.

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.

1 participant