Skip to content

馃摎 Documentation: Add Vale linting for all generated docs and examples#1822

Description

@ChiragAgg5k

Description

Add Vale validation for every Markdown file produced by the SDK generator, including SDK READMEs, generated documentation, and Markdown examples.

Markdown is generated across many language templates, so style issues can be repeated in every published SDK. The generated output in examples/<lang>/ is the ground truth and should be checked after generation rather than linting Twig templates alone.

Proposed changes

  • Add a repository-wide Vale configuration and shared vocabulary/style rules for generated Markdown.
  • Update Markdown templates so all generated READMEs, docs, and examples pass Vale.
  • Add a script that generates the supported SDK outputs and runs Vale against every generated *.md file under examples/.
  • Run that check in CI when generator code, Markdown templates, or Vale configuration changes.
  • Document the local command contributors should run after editing Markdown-producing templates.

Acceptance criteria

  • All Markdown files emitted by every supported generator target are included; the check is not limited to top-level READMEs.
  • Generated documentation and Markdown examples pass Vale without errors.
  • Necessary technical terms and product names are captured in a checked-in vocabulary instead of being suppressed ad hoc.
  • Intentional exceptions, such as verbatim third-party specification text, are narrowly scoped and documented.
  • CI fails when a template change introduces a Vale error in generated Markdown.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions