Add doc validation workflow + fix linting errors#779
Merged
Conversation
0b2613a to
4c04b18
Compare
956de5f to
6c83738
Compare
markstory
approved these changes
Apr 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an automated documentation validation workflow for the docs/ subtree and updates the docs sources to satisfy formatting/linting requirements (code-fence language tags and heading/list formatting), alongside a small Node/VitePress config compatibility tweak.
Changes:
- Add a GitHub Actions workflow to validate documentation changes on PRs and on pushes to
4.x. - Switch the docs Node package to ESM (
"type": "module") to align with the ESM-based VitePress config. - Normalize markdown formatting across multiple pages (language-tagged code fences, list/heading formatting).
Reviewed changes
Copilot reviewed 4 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/docs-validation.yml |
Adds a reusable-workflow-based docs validation job for changes under docs/** / .github/**. |
docs/package.json |
Switches the docs package to ESM (type: module) to match the VitePress config module format. |
docs/en/view-helper.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/url-checkers.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/upgrade-3-to-4.md |
Normalizes code-fence language tags and list formatting in migration tips. |
docs/en/upgrade-2-to-3.md |
Normalizes bash code-fence language tag ( ```bash). |
docs/en/testing.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/redirect-validation.md |
Normalizes text/php code-fence language tags and numbered-list formatting. |
docs/en/password-hashers.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/migration-from-the-authcomponent.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/middleware.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/index.md |
Normalizes bash/shell/php code-fence language tags ( ```bash, ```shell, ```php). |
docs/en/impersonation.md |
Normalizes PHP code-fence language tags and numbered-list formatting. |
docs/en/identity-object.md |
Normalizes php/text code-fence language tags. |
docs/en/identifiers.md |
Normalizes PHP code-fence language tags ( ```php). |
docs/en/contents.md |
Adjusts heading level for consistency (## instead of ###). |
docs/en/authenticators.md |
Normalizes code-fence language tags ( ```php, ```text) and trims an extra blank line. |
docs/en/authentication-component.md |
Normalizes PHP code-fence language tags ( ```php). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.