Skip to content

Add a CI job to validate docs.json references exist#9

Merged
wjdp merged 4 commits intomainfrom
validate-docs-ci
Aug 15, 2025
Merged

Add a CI job to validate docs.json references exist#9
wjdp merged 4 commits intomainfrom
validate-docs-ci

Conversation

@wjdp
Copy link
Collaborator

@wjdp wjdp commented Aug 15, 2025

No description provided.

@wjdp wjdp requested a review from Copilot August 15, 2025 10:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a CI workflow to validate documentation references by implementing an automated check that runs the validate-docs script. The purpose is to ensure that all documentation pages referenced in docs.json actually exist in the repository.

  • Adds a new GitHub Actions workflow to validate documentation references
  • Introduces a new npm script validate-docs that runs a TypeScript validation tool
  • Updates project dependencies to support the validation script

Reviewed Changes

Copilot reviewed 2 out of 5 changed files in this pull request and generated 1 comment.

File Description
package.json Adds validate-docs script, updates mintlify version, and includes TypeScript dependencies
.github/workflows/validate-docs.yml Creates new CI workflow to run documentation validation on pushes and PRs

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@wjdp wjdp merged commit 3e8ab68 into main Aug 15, 2025
4 checks passed
@wjdp wjdp deleted the validate-docs-ci branch August 15, 2025 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants