Draft improvements from user feedback: clarify ignore/sourceRef/monorepo/domain#6408
Open
mintlify[bot] wants to merge 2 commits into
Open
Draft improvements from user feedback: clarify ignore/sourceRef/monorepo/domain#6408mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
Targeted clarifications on four pages that received "not helpful" contextual feedback in the past week.
Changes
/organize/mintignore— Added a note explaining that.mintignorecontrols processing and publishing, not build triggers: changes to ignored files still cause a preview deployment./deploy/multi-repo— Explicitly called out thatmenuentries inside tabs don't acceptsourceRef, so the supported list is unambiguous./deploy/monorepo— Replaced the outdated "Set up as monorepo" toggle step and image alt text with the current "docs.json is in a subdirectory" toggle wording./api/static-export/start-job— Expanded thedomainfield description (in the page and OpenAPI spec) to make clear it is the custom domain configured in the dashboard (or the Mintlify subdomain), hostname only, no protocol or path prefix.Feedback basis
Themes drawn from recent contextual feedback:
.mintignorepage conflates "excluded from publishing" with "excluded from triggering preview deploys."sourceRefsupported-list is exhaustive-looking but doesn't state whethermenuis included.domainparameter didn't specify whether it referred to the custom domain, Mintlify subdomain, or a path.Dashboard links:
Note
Low Risk
Copy and OpenAPI description changes only; no application or runtime behavior is modified.
Overview
Documentation-only updates (English plus es, fr, zh) that address recent contextual feedback on four topics.
.mintignore— Adds a note that ignored paths still trigger PR preview builds; exclusion applies at publish time, not to deploy triggers.Multi-repo
sourceRef— States explicitly thatmenuentries inside a tab do not acceptsourceRef, narrowing the supported-navigation list.Monorepo Git settings — Replaces outdated Set up as monorepo wording and screenshot alt text with the current docs.json is in a subdirectory toggle label.
Static export
domain— Expands the start-job page copy and OpenAPIStartStaticExportRequest.domaindescriptions: dashboard custom domain or Mintlify subdomain, hostname only (no protocol, trailing slash, or path prefix).Reviewed by Cursor Bugbot for commit 1520a05. Bugbot is set up for automated code reviews on this repo. Configure here.