Skip to content

Add a docs check for links, redirects and the sidebar - #1815

Merged
katarinasupe merged 2 commits into
mainfrom
add/pr-checks
Oct 7, 2026
Merged

katarinasupe merged 2 commits into
mainfrom
add/pr-checks

Conversation

@katarinasupe

Copy link
Copy Markdown
Contributor

Adds scripts/check-docs.mjs (pnpm check) and runs it on every PR. It reads the checkout only (no build, no network, about a second) and fails on links to missing pages or sections, links through a redirect, broken redirects, pages missing from _meta.ts, missing images and release-note version mismatches. Problems show on the PR's changed lines.

The first commit fixes what it found on main, so it starts green: six pages missing from _meta.ts (added at the end with their current titles, so the sidebar doesn't change) and a duplicated Memgraph v2.10.1 release note.

…note

Six pages weren't in their folder's _meta.ts and transformation-modules had none; they're added at the end with their current titles, so the sidebar looks the same. The second Memgraph v2.10.1 section repeated the first.
scripts/check-docs.mjs reads the checkout (no build, no network) and fails on links to missing pages or sections, links through a redirect, broken redirects, pages missing from _meta.ts, missing images and release-note version mismatches. Runs on every PR and as pnpm check.
@katarinasupe katarinasupe self-assigned this Oct 7, 2026
@vercel

vercel Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
documentation Ready Ready Preview Oct 7, 2026 9:33am UTC

Request Review

@katarinasupe
katarinasupe marked this pull request as ready for review October 7, 2026 10:22
@katarinasupe
katarinasupe merged commit 5955c4f into main Oct 7, 2026
3 checks passed
@katarinasupe
katarinasupe deleted the add/pr-checks branch October 7, 2026 10:25

This branch was successfully deployed

1 active deployment
Preview — 385a4c59 Deployed Oct 7, 2026 by vercel[bot]
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