Document /mintlify-assets and /_mintlify routing for subpath proxies#6687
Open
aicortez wants to merge 2 commits into
Open
Document /mintlify-assets and /_mintlify routing for subpath proxies#6687aicortez wants to merge 2 commits into
aicortez wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
ethanpalm
approved these changes
Jul 21, 2026
ethanpalm
left a comment
ethanpalm
left a comment
Collaborator
There was a problem hiding this comment.
one small suggestion to make the warning a little easier to read. lgtm!
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
3 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
Subpath reverse proxies must forward two root-level paths to
<subdomain>.mintlify.sitein addition to the docs subpath:/mintlify-assets/*— CSS/JS chunks and favicons are emitted with a root-relative asset prefix, so they are requested from the domain root, not the subpath. Without this, docs render unstyled with broken scripts./_mintlify/*— the API playground posts to/_mintlify/api/requestat the domain root.The Vercel guide's config generator already includes both rewrites, but the Cloudflare Workers guide covered neither (a customer had to discover the assets route themselves), and the AWS guide only covered
/mintlify-assets/_next/static/*, which misses favicons and the playground path.Changes:
deploy/cloudflare.mdx: both example Worker scripts now match/mintlify-assets/and/_mintlify/; added a warning about covering these paths in Worker routes when not using a custom domain.deploy/route53-cloudfront.mdx: widened/mintlify-assets/_next/static/*to/mintlify-assets/*and added a/_mintlify/*behavior (CachingDisabled, all HTTP methods).Note: the dashboard-generated Worker snippet (
AdditionalSettings.tsxin mint) has the same gap and needs a separate fix.Test Plan
mint broken-linkspasses./mintlify-assets/...at the domain root, and the API playground posts to root-level/_mintlify/api/request(useSendPlaygroundRequest.ts).🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes to deployment guides; no application code or infrastructure behavior in this repo.
Overview
Subpath reverse-proxy docs now require forwarding root-level
/mintlify-assets/*and/_mintlify/*to Mintlify, not only the docs subpath—without them, styled assets and the API playground break.Cloudflare Workers (
deploy/cloudflare.mdx): both example Worker scripts proxy those paths alongside/docs; a new warning explains why they’re needed and that route patterns must includeyoursite.com/mintlify-assets/*andyoursite.com/_mintlify/*when not using a custom domain.AWS CloudFront (
deploy/route53-cloudfront.mdx): overview and behaviors widen cached routing from/mintlify-assets/_next/static/*to/mintlify-assets/*, and add a/_mintlify/*behavior (caching disabled, all HTTP methods) for playground API traffic.Reviewed by Cursor Bugbot for commit 936226a. Bugbot is set up for automated code reviews on this repo. Configure here.