Add guide: Run the Mintlify CLI in CI

[mintlify-development]

Documentation changes

Adds a new guide, guides/cli-in-ci.mdx, covering how to run the Mintlify CLI in a CI pipeline: which commands to use (mint validate, mint broken-links, mint a11y), sample GitHub Actions and GitLab CI configs, a pre-commit hook, how to scope link checks to changed files, and a small troubleshooting section. Also linked from the "Best practices" group in the Learn tab of docs.json.

Closes

---

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

• Code examples work as written
• Commands and configurations are correct
• Links resolve to the right destinations
• Prerequisites and requirements are accurate

✅ Clarity and completeness

• Instructions are clear and easy to follow
• Steps are in logical order
• Nothing important is missing
• Examples help illustrate the concepts

✅ User experience

• A new user could follow these docs successfully
• Common gotchas or edge cases are addressed
• Error messages or troubleshooting guidance is helpful

---

Generated by Mintlify Agent.

Requested by: patrick+1@mintlify.com via Slack
Mintlify session: slack_1784932788.683829_C0A40JDM342

---

Note

Low Risk
Documentation-only change with no application, auth, or data-handling impact.

Overview
Adds guides/cli-in-ci.mdx, a Learn-tab guide for running mint validate, mint broken-links, and mint a11y in your own CI or pre-commit flow, and links it under Best practices in docs.json.

The page contrasts Mintlify’s hosted CI checks with self-managed pipelines, documents sample GitHub Actions and GitLab CI jobs (path filters, Node 20, global mint install), a local pre-commit hook, and mint broken-links --files with a scheduled full run for large sites. It ends with troubleshooting for missing CLI on PATH, flaky external link checks, and CI-only validation failures (e.g. generated OpenAPI).

^{Reviewed by Cursor Bugbot for commit 7870f33. Bugbot is set up for automated code reviews on this repo. Configure here.}

[mintiebot]

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

Project	Status	Preview	Updated (UTC)
tomee	🟢 Ready	View Preview	Jul 24, 2026, 10:51 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[mintlify]

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

Project	Status	Preview	Updated (UTC)
mintlify	🟢 Ready	View Preview	Jul 24, 2026, 10:51 PM