Docs: PR preview workflow and validate CI

[AllenAJ]

Summary

• Documents Mintlify preview deployments in the contributing guide
• Adds mint validate on pull requests (and main pushes)

Test plan

• Mintlify bot posts a preview deployment link on this PR
• GitHub Actions Validate docs passes
• Preview URL loads and shows README changes only

Made with Cursor

Summary by CodeRabbit

• Chores

  • Added automated documentation validation checks to pull requests.

• Documentation

  • Updated contribution guidelines with documentation preview process and validation requirements for pull requests.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR adds Mintlify documentation validation to the CI pipeline via a new GitHub Actions workflow, and updates the contributor README to document the preview-before-merge workflow for documentation reviewers.

Changes

Mintlify Validation and Preview Setup

Layer / File(s)	Summary
Mintlify CI validation workflow .github/workflows/mint-validate.yml	New GitHub Actions workflow runs mint validate on pull_request and push events targeting main, using Node.js 20 on ubuntu-latest.
Preview workflow documentation README.md	README "Submitting changes" section documents the Mintlify preview-before-merge process, including GitHub app deployment requirements, manual preview creation via Mintlify dashboard, and notes that CI runs validation on each PR.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A workflow to validate, a guide to preview clear,
Mint checks the docs with each push near,
Preview before merge, the path is clean,
Documentation workflows, now well-seen! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Docs: PR preview workflow and validate CI' clearly summarizes the two main changes: adding documentation about PR preview deployments and adding a CI validation workflow for docs.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/preview-deployments-workflow

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[AllenAJ]

Closing: not pursuing Mintlify PR preview deployments.