chore: docs workflow skip - root README.md change (DO NOT MERGE - DELETE AFTER ENG-2148)

[mcstepp]

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

• Test A
• Test B

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

[linear]

ENG-2149 [APPS] [P4] Engineering Workflow

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5fab90b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
dashboard	Ignored	Preview		Nov 3, 2025 6:52pm
engineering	Ignored	Preview		Nov 3, 2025 6:52pm

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[coderabbitai]

📝 Walkthrough

Walkthrough

Three changes: a non-functional HTML comment added to the repository README, the deploy workflow was gated on a detect_changes job output, and the detect_changes workflow’s docs path filter was narrowed to apps/docs/**.

Changes

Cohort / File(s)	Summary
Documentation comment README.md	Inserted HTML comment <!-- Test: root README change should NOT trigger docs workflows --> in the first centered block (non-functional).
CI: deploy gating .github/workflows/deploy.yaml	mintlify_deployment job dependency changed from api_production_deployment to detect_changes; added if: needs.detect_changes.outputs.docs == 'true' guard so deployment runs only when docs change is detected.
CI: docs detection filter .github/workflows/job_detect_changes.yaml	Narrowed docs filter header and path to only include apps/docs/** (removed previous broader inclusions/exclusions), restricting what triggers docs detection.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant PR as Pull Request
  participant Detect as detect_changes job
  participant Deploy as mintlify_deployment job

  PR->>Detect: push / PR files
  alt paths include apps/docs/**
    Detect-->>Deploy: outputs.docs = 'true'
    Deploy->>Deploy: run redeploy steps
  else paths do not include apps/docs/**
    Detect-->>Deploy: outputs.docs = 'false'
    Note right of Deploy: mintlify_deployment skipped due to condition
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Pay attention to .github/workflows/deploy.yaml conditional logic and job dependency change for correctness of needs.detect_changes.outputs.docs reference and job names.
• Verify job_detect_changes.yaml filter semantics (path patterns) to ensure intended files trigger detection and outputs/docs are still produced.

Possibly related PRs

• chore: CI improvements part 1. #3176 — modifies job_detect_changes.yaml, related change to detect_changes workflow narrowing docs detection.
• chore: update dashboard workflow to run relevant actions #4210 — also adjusts path-filter definitions in job_detect_changes.yaml, related to how docs/dashboard paths are handled.

Suggested labels

Papercut

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is largely empty, using the template boilerplate with no specific issue reference, unchecked type-of-change boxes, and placeholder test steps ('Test A', 'Test B').	Replace placeholder text with concrete details: link the ENG-2149 issue, check the 'Chore' box, describe actual workflow changes and testing steps, and document which checklist items were completed.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main objective: preventing docs workflow triggers on root README.md changes by modifying workflow detection logic.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch test-docs-workflow-root-readme

---

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 and usage tips.}

[linear]

ENG-2148 [APPS] [P1] Docs Workflow