You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reviewed customer feedback from the last month (Linear CUS tickets, Slack, Notion product feedback). Most items were code/product bugs already tracked for engineering. The three issues below were genuine documentation gaps where users were misled by missing scope/limitation notes.
Changes
organize/settings-reference.mdx — Note that {{variable}} substitution applies to MDX/snippets only, not OpenAPI spec files. (CUS-1618)
cli/commands.mdx — Clarify that mint broken-links scans .mdx/.md only, not OpenAPI YAML/JSON. (CUS-1619)
deploy/gitlab.mdx — Note that push-based automation workflows currently only trigger on MR merges, not direct pushes to the default branch on GitLab. (CUS-1582)
Considered but not included
CUS-1640 (keywords frontmatter not emitting <meta name="keywords">) — product bug being fixed; docs match intended behavior.
CUS-1608 ("Open in Cursor/Claude" broken .md URL on index pages) — URL-generation bug, not a docs gap.
mint validate reports a preexisting docs.json error unrelated to this PR (download-spec enum + custom-option type), present on main.
Generated by Mintlify Agent.
Requested by: jadon@mintlify.com via Slack
Mintlify session: slack_1782763003.365179_C09FX8PRQ1K
Note
Low Risk
Documentation-only clarifications with no product or security behavior changes.
Overview
Adds three scope/limitation notes so docs match actual product behavior after customer feedback.
The variables section in settings-reference.mdx now states that {{variableName}} substitution runs on MDX pages and snippets only—not on OpenAPI specs (.yaml, .yml, .json) or other static assets.
The mint broken-links docs in commands.mdx now say the command scans .mdx and .md for links (still respecting .mintignore) and does not validate links inside OpenAPI specification files.
The GitLab webhook guide in gitlab.mdx adds a note that push-triggered automation workflows on the deployment branch currently fire on merge request merges, not on direct pushes to that branch on GitLab.
Reviewed by Cursor Bugbot for commit 1c2437d. Bugbot is set up for automated code reviews on this repo. Configure here.
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
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.
Reviewed customer feedback from the last month (Linear
CUStickets, Slack, Notion product feedback). Most items were code/product bugs already tracked for engineering. The three issues below were genuine documentation gaps where users were misled by missing scope/limitation notes.Changes
organize/settings-reference.mdx— Note that{{variable}}substitution applies to MDX/snippets only, not OpenAPI spec files. (CUS-1618)cli/commands.mdx— Clarify thatmint broken-linksscans.mdx/.mdonly, not OpenAPI YAML/JSON. (CUS-1619)deploy/gitlab.mdx— Note that push-based automation workflows currently only trigger on MR merges, not direct pushes to the default branch on GitLab. (CUS-1582)Considered but not included
keywordsfrontmatter not emitting<meta name="keywords">) — product bug being fixed; docs match intended behavior..mdURL on index pages) — URL-generation bug, not a docs gap.Validation
mint broken-links→ no broken links.mint validatereports a preexistingdocs.jsonerror unrelated to this PR (download-specenum + custom-option type), present onmain.Generated by Mintlify Agent.
Requested by: jadon@mintlify.com via Slack
Mintlify session: slack_1782763003.365179_C09FX8PRQ1K
Note
Low Risk
Documentation-only clarifications with no product or security behavior changes.
Overview
Adds three scope/limitation notes so docs match actual product behavior after customer feedback.
The
variablessection insettings-reference.mdxnow states that{{variableName}}substitution runs on MDX pages and snippets only—not on OpenAPI specs (.yaml,.yml,.json) or other static assets.The
mint broken-linksdocs incommands.mdxnow say the command scans.mdxand.mdfor links (still respecting.mintignore) and does not validate links inside OpenAPI specification files.The GitLab webhook guide in
gitlab.mdxadds a note that push-triggered automation workflows on the deployment branch currently fire on merge request merges, not on direct pushes to that branch on GitLab.Reviewed by Cursor Bugbot for commit 1c2437d. Bugbot is set up for automated code reviews on this repo. Configure here.