ci: build docs on PRs to catch dead links#96
Merged
Merged
Conversation
vitepress build fails on dead internal links (the docs config ignores only localhost links), so a docs job on every PR doubles as a link check. Closes #59
suleimansh
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #59.
Adds a
docsjob to CI that runspnpm --filter @gemstack/docs docs:buildon every PR. VitePress fails its build on dead internal links (the docs config whitelists onlylocalhost), so this doubles as a dead-link check — verified locally: a bogus/packages/does-not-existlink makes the build exit non-zero with1 dead link(s) found.Runs as a separate job (parallel to build/typecheck/test) so a docs-only break is a distinct red check.