Repository navigation
docs(deploy): document root mintlify proxy paths - #7935
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
lucaspunz
marked this pull request as ready for review
October 21, 2026 05:46
This branch was successfully deployed
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
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
Document the root
/_mintlify/*and/mintlify-assets/*paths in the subpath proxy guides, and recommend passing through origin cache headers for them.Test Plan
mint broken-linksNote
Low Risk
Documentation-only changes to deployment guides with no runtime or application code impact.
Overview
Updates subpath deployment guides (Cloudflare, Vercel, Route 53/CloudFront, nginx reverse proxy, and the overview page) so
/_mintlify/*and/mintlify-assets/*must be proxied from the domain root, not under the docs base path. The docs explain that these paths carry CSS, JS, fonts, favicons, and API traffic, and that subpath-only proxies cause unstyled pages.Caching and methods: CloudFront and reverse-proxy guidance now recommends passing through Mintlify origin cache headers for those asset paths instead of fixed “cache everything” or “cache nothing” policies. Analytics/API behavior is documented as
POSTto/_mintlify/api/*, with proxies required to allow all HTTP methods on docs and/_mintlify/*.Operational fixes: Adds nginx
locationexamples for the root paths, a “pages load without styles” troubleshooting section, expanded Cloudflare WAF exception rules for/_mintlify/, and refreshed Vercel external-proxy path allowlists.Reviewed by Cursor Bugbot for commit 2ea4393. Bugbot is set up for automated code reviews on this repo. Configure here.