Skip to content

Documentation quality check: restore BYOM mention on credits page - #7352

Merged
mintlify[bot] merged 2 commits into
mainfrom
mintlify/7de3fad5
Sep 12, 2026
Merged

mintlify[bot] merged 2 commits into
mainfrom
mintlify/7de3fad5

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Reviewed the 12 English MDX files updated between 2026-09-11 and 2026-09-12 and found one real reader gap.

Changes

credits.mdx

  • Gap: The page previously had a "Bring your own model" subsection under "Reduce credit usage." A prior PR removed it because BYOM no longer meters at a reduced rate. The follow-up PR (Update from code changes: BYOK AI usage no longer uses credits #7335) updated ai/bring-your-own-model.mdx to say BYOM usage does not consume credits at all, but credits.mdx was left with no mention of BYOM. A reader asking "how do I reduce credit usage?" no longer finds this option, even though it now removes credit usage entirely on the configured deployment.
  • Fix: Added a short "Bring your own model" subsection under "Reduce credit usage" that states BYOM usage does not consume Mintlify credits, links to the BYOM page, and notes the per-deployment scope so readers understand shared organization credits still apply elsewhere.

Pages evaluated with no changes needed

  • ai/bring-your-own-model.mdx — Reference/how-to. Answers provider coverage, configuration, credit behavior, per-deployment scope, key rotation, and removal.
  • changelog.mdx — Running changelog; page format, not a candidate for reader-question analysis.
  • cli/commands.mdx — CLI reference. Recent mint format warning and tip cover the "watch out" material. Wording of the added Tip is slightly awkward but does not leave a factual gap.
  • components/icons.mdx — Component reference. Emoji is now listed as an option in the intro, the shared iconType snippet, and the color field note.
  • components/tabs.mdx — Component reference. icon field now lists Tabler and emoji.
  • components/view.mdx — Component reference. icon field now lists Tabler and emoji.
  • create/reusable-snippets.mdx — Reference/how-to. New note on client-side evaluation of MDX expressions closes the previous gap.
  • deploy/reverse-proxy.mdx — How-to. Long-standing page with recent typo fix; routing table, headers, nginx example, and troubleshooting all present.
  • help-center/register-external-mcp-server-in-discovery.mdx — Explanation/how-to. New page covers why Mintlify's discovery endpoints don't list external servers, two workarounds (reverse-proxy override, publish URL directly), and the unsupported cases.
  • organize/pages.mdx — Frontmatter reference. Emoji option added under icon.
  • organize/settings-reference.mdx — Configuration reference. icon cells updated to mention emoji.

Note

Low Risk
Documentation-only changes to credits and BYOM messaging; no product or billing code paths.

Overview
Restores Bring your own model on the credits page under Reduce credit usage, so readers looking to cut Mintlify credit spend again see Enterprise BYOM as an option.

The new copy matches the updated BYOM policy: AI on a deployment with BYOM enabled does not consume Mintlify credits (replacing the old half-rate wording), with direct provider billing and a note that BYOM is per deployment while other deployments still use the shared org balance. English adds the subsection; es, fr, and zh credits.mdx move the same block to sit after “find what’s consuming credits” and apply the same factual update.

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

@mintlify

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated
mintlify 🟢 Ready View Preview Sep 12, 2026, 10:13 AM

@mintlify
mintlify Bot merged commit d380a12 into main Sep 12, 2026
5 checks passed
@mintlify
mintlify Bot deleted the mintlify/7de3fad5 branch September 12, 2026 20:04
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