Skip to content

feat: add validate-docs-redirects script and test#1127

Draft
David Traum (davidtraum) wants to merge 2 commits intomainfrom
feat/add-docs-redirect-validation
Draft

feat: add validate-docs-redirects script and test#1127
David Traum (davidtraum) wants to merge 2 commits intomainfrom
feat/add-docs-redirect-validation

Conversation

@davidtraum
Copy link
Copy Markdown

@davidtraum David Traum (davidtraum) commented Apr 16, 2026

What?

This PR adds a script to validate the redirects for the pages of the Meteor admin SDK documentation which are listed inside docs.yml.

Why?

Without validation it is easy to miss adding a redirect for a moved page.

How?

The script can be called using pnpm run validate:docs-redirects and is included in the static-analysis checks.

It does two things:

  • Checking the diff of the current branch to check, if files have been moved and dont have a redirect
  • Checking if all current redirect targets are still valid

Testing?

  • Run pnpm run validate:docs-redirects with the current valid docs.yml file. No error occurs.
  • Change a redirect path in the file to a non existent target
  • Run the command again -> The script exits with an error

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 16, 2026

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

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
meteor-component-library Ignored Ignored Preview Apr 16, 2026 7:51am

Request Review

@davidtraum David Traum (davidtraum) changed the base branch from main to docs-changes-mar12 April 16, 2026 07:59
@davidtraum David Traum (davidtraum) changed the base branch from docs-changes-mar12 to main April 16, 2026 07:59
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.

1 participant