Add docs syntax check workflow for docs/en Markdown#25415
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a PR-only CI workflow to validate Scriban template parsing/rendering for changed docs/en/**/*.md files, aiming to catch template syntax/variable issues before docs are published.
Changes:
- Introduces a new GitHub Actions workflow that gathers PR-changed Markdown files (and detects
docs-params.jsonchanges) and runs a syntax checker against them. - Adds a small .NET console app that parses Scriban templates and performs a strict-mode render with injected parameter keys.
- Adds a dedicated
.csprojfor the checker with a Scriban dependency.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/workflows/check-docs-syntax.yml | New PR workflow to build and run the Scriban syntax checker on changed docs/en markdown (or index.md when only params changed). |
| .github/scripts/CheckDocsSyntax/Program.cs | Implements Markdown enumeration, Scriban parse diagnostics, strict render pass, and GitHub Actions annotations. |
| .github/scripts/CheckDocsSyntax/CheckDocsSyntax.csproj | Adds the .NET console project for the checker with Scriban package reference. |
Contributor
Docs syntax check passedThe previously reported issues are no longer present in this PR. |
enisn
approved these changes
May 12, 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.
Adds a CI check that validates the Scriban template syntax inside
docs/en/**/*.mdwhenever a PR touches them. The checker is a small .NET console app that runsTemplate.Parseplus a strict-mode render, with the same parameter dictionary the docs renderer injects at runtime, so escape issues are surfaced before they reach the published documentation site.The workflow only inspects markdown files changed by the PR, plus
docs/en/docs-params.jsonso that parameter file changes also trigger validation against a known-clean page.