Skip to content

Add doc validation workflow + fix linting errors#779

Merged
josbeir merged 5 commits into4.xfrom
doc-validation-workflow
Apr 3, 2026
Merged

Add doc validation workflow + fix linting errors#779
josbeir merged 5 commits into4.xfrom
doc-validation-workflow

Conversation

@josbeir
Copy link
Copy Markdown
Contributor

@josbeir josbeir commented Apr 2, 2026

No description provided.

@josbeir josbeir force-pushed the doc-validation-workflow branch from 0b2613a to 4c04b18 Compare April 2, 2026 09:02
@josbeir josbeir changed the title Add doc validation workflow Add doc validation workflow + fix linting errors Apr 2, 2026
@josbeir josbeir force-pushed the doc-validation-workflow branch from 956de5f to 6c83738 Compare April 2, 2026 09:21
@josbeir josbeir marked this pull request as ready for review April 3, 2026 15:03
Copilot AI review requested due to automatic review settings April 3, 2026 15:03
@josbeir josbeir merged commit dfd100b into 4.x Apr 3, 2026
10 checks passed
@josbeir josbeir deleted the doc-validation-workflow branch April 3, 2026 15:04
Copy link
Copy Markdown
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 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.

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.

3 participants