Skip to content

unbroken#328

Merged
guergabo merged 3 commits intomainfrom
broken
Apr 13, 2026
Merged

unbroken#328
guergabo merged 3 commits intomainfrom
broken

Conversation

@guergabo
Copy link
Copy Markdown
Collaborator

@guergabo guergabo commented Apr 13, 2026

Description

Please provide an explanation of the changes you've made:

[Describe what this PR does and why]

Implementation Checklist

  • If updating our sample apps, update the info in our Quickstart
  • If updating our CLI, update the info in our CLI

Testing

  • mintlify dev works (see installation here)

Docs

  • Link to a PR in our docs repo documenting your change (if applicable)

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:]
[Screenshot description]

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-links on PRs and pushes to main to catch broken documentation links.

Updates multiple docs to fix/standardize links (many internal /api-reference links are converted to https://kernel.sh/docs/..., a few doc paths are corrected), and fixes the README license link to point to LICENSE instead of LICENSE.md.

Reviewed by Cursor Bugbot for commit 4171136. Bugbot is set up for automated code reviews on this repo. Configure here.

@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

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 @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Medium risk.

What changed:

  • Added a new CI workflow at .github/workflows/broken-links.yml that runs on both pull_request and pushes to main.
  • The workflow installs and executes external tooling (npm install -g mintlify and mint 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 main pushes, so the blast radius is repo-wide for CI behavior.

Decision:

  • Not approving, since approval is limited to Very Low/Low risk changes.
Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Medium risk.

What changed:

  • Added a new CI workflow at .github/workflows/broken-links.yml.
  • Workflow runs on both pull_request and pushes to main.
  • It installs and executes external tooling (npm install -g mint and mint 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 main pushes.

Decision:

  • Not approving, since approval is limited to Very Low/Low risk changes.
Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 13, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Apr 13, 2026, 4:09 PM

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

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Medium risk.

What changed:

  • Added a new GitHub Actions workflow at .github/workflows/broken-links.yml.
  • The workflow runs on every pull_request and on pushes to main.
  • It installs and executes external tooling (npm install -g mint and mint 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.
Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@guergabo
Copy link
Copy Markdown
Collaborator Author

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.

@guergabo guergabo merged commit 1282e6e into main Apr 13, 2026
4 checks passed
@guergabo guergabo deleted the broken branch April 13, 2026 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants