Skip to content

Add automated documentation validation workflow#8167

Merged
josbeir merged 3 commits into5.xfrom
github-validation-actions
Jan 28, 2026
Merged

Add automated documentation validation workflow#8167
josbeir merged 3 commits into5.xfrom
github-validation-actions

Conversation

@josbeir
Copy link
Contributor

@josbeir josbeir commented Jan 27, 2026

Implements GitHub Actions workflow to validate documentation PRs with four independent checks:

Checks:

  • JS Syntax: Validates config.js syntax
  • JSON Validation: Validates toc_*.json files
  • Markdown Linting: Enforces VitePress-compatible rules (allows code groups, callouts, inline HTML)
  • Spell Checking: Multi-language support (EN/JA) with technical term dictionary

Configuration:

  • cspell.json: Lenient spellcheck config that ignores code blocks, PascalCase, snake_case, variables, URLs, and common PHP/CakePHP terms
  • markdownlint.json: VitePress-optimized rules supporting Japanese characters and custom markdown features

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 :-)

Copilot AI review requested due to automatic review settings January 27, 2026 14:45
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 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.

@josbeir josbeir force-pushed the github-validation-actions branch 2 times, most recently from 91e8ba7 to 387b5a6 Compare January 27, 2026 14:57
@josbeir josbeir merged commit a0d880b into 5.x Jan 28, 2026
4 checks passed
@josbeir josbeir deleted the github-validation-actions branch January 28, 2026 06:21
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.

4 participants