ci: scope docs quality checks with native paths

[Siddhant-K-code]

Summary

Use GitHub's native paths filters with directory-wide patterns to scope docs quality checks.

• Docs, src/**, scripts/**, tests/**, patches/**, and .github/workflows/** trigger the suite, along with listed root dependencies/configuration. Blog and static-asset-only changes skip it.
• The existing file-preservation test runs on every PR through Test deployment. No new custom workflow test suite.
• Manual runs and nightly updaters are unchanged. No external path-filter action.

Keep the path-filtered docs-quality status optional so skipped runs do not block merges.

Context

Follow-up to #1388. The original YAML failure is already fixed on docs-next; this PR scopes CI while retaining the existing file-preservation safeguard.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 18615381-d817-498e-81b7-7380383c8d88

📥 Commits

Reviewing files that changed from the base of the PR and between 076aa29 and 8da0c1e.

📒 Files selected for processing (6)

• .github/workflows/mintlify-quality.yml
• package.json
• scripts/README.md
• scripts/docs-check-scope.mjs
• scripts/docs-check-scope.test.mjs
• scripts/workflow-syntax.test.mjs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The pull request adds workflow syntax validation and a script that identifies documentation-related changes. The Mintlify quality checks now run only when the script reports documentation changes.

Changes

Documentation Quality Workflow

Layer / File(s)	Summary
Documentation impact detection scripts/docs-check-scope.mjs, scripts/docs-check-scope.test.mjs	The scope script classifies documentation-related paths, validates event and revision inputs, selects Git diff ranges, and reports matching files. Tests cover path classification, revision ranges, CLI output, and failure cases.
Workflow validation and quality gates .github/workflows/mintlify-quality.yml, package.json, scripts/workflow-syntax.test.mjs, scripts/docs-check-scope.test.mjs, scripts/README.md	The workflow fetches full Git history, runs workflow and scope regression tests, and checks documentation impact. Mintlify quality checks run only when documentation changes are detected. The README describes the checks and their event-specific ranges.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant Workflow as mintlify-quality.yml
  participant Tests as Node test runner
  participant Scope as docs-check-scope.mjs
  participant Git
  participant Mintlify as Mintlify quality checks
  Workflow->>Tests: Run npm run test:workflows
  Workflow->>Scope: Pass event name and revision SHAs
  Scope->>Git: Diff the selected revision range
  Git-->>Scope: Return changed paths
  Scope-->>Workflow: Set docs_changed output
  Workflow->>Mintlify: Run checks when docs_changed is true

Loading

Merge Risk: ⚪ Minimal · up to 8da0c

No actionable merge-blocking risk is established for the conditional documentation checks.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 6 functions across 3 files. (3 skipped: 3 …	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: using native path-based scoping to control documentation quality checks in CI.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 6 functions across 3 files. (3 skipped: 3 unsupported.)

• Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-14 14:06 UTC

[Copilot]

Copilot review overview

🟡 Changes recommended

Deleting or moving required website files can skip the existing boundary-preservation checks.

Review effort: Balanced
Findings: 1

Open (1)

• Detect deletions and moves of required site files · New

What changed in this PR

Reduces unnecessary docs-quality runs while preserving the required check and always validating workflow syntax.

Changes:

• Adds docs-impact classification using PR and push comparison ranges.
• Gates the full docs suite while retaining workflow syntax checks.
• Adds regression tests and documents the scoping policy.

File	Description
scripts/​workflow-syntax.test.mjs	Validates workflow YAML and shell syntax.
scripts/​README.md	Documents check scope and regression commands.
scripts/​docs-check-scope.test.mjs	Tests classification, comparison ranges, and workflow gates.
scripts/​docs-check-scope.mjs	Determines docs impact and reports run decisions.
package.json	Adds the workflow regression command.
.github/​workflows/​mintlify-quality.yml	Always validates workflows and conditionally runs docs checks.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.