Conversation
|
Firetiger deploy monitoring skipped This PR didn't match the auto-monitor filter configured on your GitHub connection:
Reason: PR body is a template with no actual changes described; please provide details about which files were modified to confirm if this affects kernel API endpoints or Temporal workflows. To monitor this PR anyway, reply with |
There was a problem hiding this comment.
Stale comment
Risk assessment: Medium risk.
What changed:
- Added a new CI workflow at
.github/workflows/broken-links.ymlthat runs on bothpull_requestand pushes tomain.- The workflow installs and executes external tooling (
npm install -g mintlifyandmint broken-links).Why this is Medium risk:
- This modifies repository automation/infrastructure rather than docs content only.
- It introduces a new dependency execution path in CI, which can affect reliability and security posture of the pipeline.
- It impacts all PRs and
mainpushes, so the blast radius is repo-wide for CI behavior.Decision:
- Not approving, since approval is limited to Very Low/Low risk changes.
Sent by Cursor Automation: Assign PR reviewers
There was a problem hiding this comment.
Stale comment
Risk assessment: Medium risk.
What changed:
- Added a new CI workflow at
.github/workflows/broken-links.yml.- Workflow runs on both
pull_requestand pushes tomain.- It installs and executes external tooling (
npm install -g mintandmint broken-links).Why this is Medium risk:
- This changes repository automation/infrastructure rather than documentation content only.
- It adds a new executable dependency path in CI, which can affect pipeline reliability and security posture.
- Blast radius is repo-wide because it runs for all PRs and
mainpushes.Decision:
- Not approving, since approval is limited to Very Low/Low risk changes.
Sent by Cursor Automation: Assign PR reviewers
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Risk assessment: Medium risk.
What changed:
- Added a new GitHub Actions workflow at
.github/workflows/broken-links.yml. - The workflow runs on every
pull_requestand on pushes tomain. - It installs and executes external tooling (
npm install -g mintandmint broken-links). - Other changes are mostly documentation link/path corrections.
Why this is Medium risk:
- This introduces a new CI/infrastructure execution path with repo-wide blast radius, not just content edits.
- Running newly introduced external CLI installation and execution in CI can affect reliability and security posture.
- Trigger scope includes all PRs and
main, so impact is broader than isolated docs page changes.
Decision:
- Not approving because approval is reserved for Very Low/Low risk changes.
Sent by Cursor Automation: Assign PR reviewers
|
NOTE: The mint broken-links tool can only validate links to pages that exist as local files in the repo. Your API reference pages aren't local files — they're auto-generated at build time from the remote OpenAPI spec at https://app.stainless.com/api/spec/documented/kernel/openapi.documented.yml. So any relative /api-reference/... link gets flagged as broken locally, even though it works fine on the live site. Converting them to absolute URLs (https://kernel.sh/docs/...) makes them external links, which mint broken-links skips by default. That's the only way to make the check pass without false positives. |


Description
Please provide an explanation of the changes you've made:
[Describe what this PR does and why]
Implementation Checklist
Testing
mintlify devworks (see installation here)Docs
Visual Proof
Please provide a screenshot or video demonstrating that your changes work locally:
[Drag and drop your screenshot/video here or use the following format:]
]
[
Related Issue
Fixes [Github issue link]
[If this corresponds to a fix from another Kernel OSS repo, include this:]
Fixes [Link to other repo]
[Replace with actual issue link, e.g., Fixes https://github.com/username/repo/issues/123]
Additional Notes
[Any additional context, concerns, or notes for reviewers]
Note
Low Risk
Low risk: changes are limited to documentation link updates and a new CI workflow; the main risk is false positives or CI failures due to external link checking.
Overview
Adds a GitHub Action that runs
mint broken-linkson PRs and pushes tomainto catch broken documentation links.Updates multiple docs to fix/standardize links (many internal
/api-referencelinks are converted tohttps://kernel.sh/docs/..., a few doc paths are corrected), and fixes the README license link to point toLICENSEinstead ofLICENSE.md.Reviewed by Cursor Bugbot for commit 4171136. Bugbot is set up for automated code reviews on this repo. Configure here.