Skip to content

docs: validate links in docs build#607

Open
brendanjryan wants to merge 3 commits intomainfrom
brendanryan-minor-edits
Open

docs: validate links in docs build#607
brendanjryan wants to merge 3 commits intomainfrom
brendanryan-minor-edits

Conversation

@brendanjryan
Copy link
Copy Markdown
Collaborator

Summary

  • add a docs link validator that checks internal docs routes and external URLs, with placeholder and flaky-host handling
  • run link validation from pnpm build, pnpm check:ci, and a new pnpm check:links command
  • fix the broken isows and Tempo session reference links surfaced by the new check

Testing

  • pnpm check:types
  • pnpm test -- scripts/check-links.test.ts
  • pnpm build

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

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

Project Deployment Actions Updated (UTC)
mpp Ready Ready Preview, Comment Apr 28, 2026 0:08am

Request Review

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 086adca9ba

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread scripts/check-links.ts
cleanPath.slice(1),
);

if (await fileExists(absoluteRootPath)) return true;
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Reject directory-only matches for internal links

Don't treat a path as valid just because access() succeeds on a repo directory. Here, internalTargetExists returns success for any absolute link whose path happens to match an existing folder (for example /scripts), even when there is no corresponding docs route or static file. That creates false negatives in the new validator and allows genuinely broken internal links to pass CI/build checks.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant