Add automated documentation validation workflow#8167
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive automated documentation validation workflow to enforce quality standards on documentation changes. The workflow includes four parallel validation checks: JavaScript syntax validation for config.js, JSON validation for table-of-contents files, Markdown linting with VitePress-compatible rules, and spell checking with multi-language support.
Changes:
- Adds GitHub Actions workflow with 4 independent validation jobs (JS, JSON, Markdown, Spelling)
- Configures markdownlint with VitePress-optimized rules supporting Japanese characters and custom HTML
- Configures cspell for multi-language spell checking with technical term dictionary and pattern ignoring
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| .github/workflows/docs-validation.yml | Defines the validation workflow with 4 jobs for syntax checking, linting, and spell checking |
| .github/markdownlint.json | Configures markdown linting rules optimized for VitePress documentation |
| .github/cspell.json | Configures spell checker with technical terms, ignore patterns, and multi-language support |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
91e8ba7 to
387b5a6
Compare
387b5a6 to
8a1a55b
Compare
LordSimal
approved these changes
Jan 27, 2026
Arhell
approved these changes
Jan 28, 2026
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
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.
Implements GitHub Actions workflow to validate documentation PRs with four independent checks:
Checks:
toc_*.jsonfilesConfiguration:
Triggers on changes to
docs/**,.github/**,toc_*.json, or config.js.Notes about markdownlint.
The markdownlint config is pretty loose for now. Its kind of a baseline from which we can work our way up in future pr's :-)