Skip to content

docs: explain which links mint broken-links checks - #8219

Merged
ethanpalm merged 1 commit into
mainfrom
autopilot/broken-links-coverage
Oct 31, 2026
Merged

ethanpalm merged 1 commit into
mainfrom
autopilot/broken-links-coverage

Conversation

@mintlify

@mintlify mintlify Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Documents which links mint broken-links checks and that paths without a leading / resolve from the page's directory, with the matching agent skill bullet. Replaces #8075, whose branch picked up unrelated changes from main.

Based on a merged CLI change that widens link extraction and fixes relative path resolution in the broken-links check.


Note

Low Risk
Documentation-only changes with no runtime or CLI code impact.

Overview
Updates mint broken-links docs in the public CLI reference and the agent cli.md skill so they match the widened link extraction and relative-path behavior in the CLI.

Both places now spell out what gets validated: Markdown links and images (including reference-style), href on <a> and <Card>, and src on <img> and <source>, including static brace values like href={"/quickstart"}; dynamic expressions are still skipped.

They also document how paths resolve: links without a leading / (for example quickstart or ../quickstart) resolve from the containing page’s directory like a browser; use a /-prefixed path for site-root links. Snippet behavior is clarified so relative and # links inside snippets are evaluated on every page that renders the snippet, with the same “broken on at least one page” reporting as before.

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

@mintlify

mintlify Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Oct 31, 2026, 9:18 AM

@github-actions

Copy link
Copy Markdown

This PR changes the Mintlify skill but no mint instructions topic. Agents read both, so check whether the matching topic in mint-instructions/ needs the same change. If not, ignore this comment.

Changed skill file Likely topics
agent-context/context/skills/mintlify/reference/cli.md every topic that mentions the changed command (grep mint-instructions/)

@ethanpalm
ethanpalm merged commit 2825dca into main Oct 31, 2026
7 checks passed
@ethanpalm
ethanpalm deleted the autopilot/broken-links-coverage branch October 31, 2026 16:29

This branch was successfully deployed

1 active deployment
staging — 4f6914f0 Deployed Oct 31, 2026 by mintlify[bot]
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.

2 participants