📚 Documentation: Add Vale linting for all generated docs and examples

Aperta
#1,822 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@kekubhai ci sta già lavorando.

Dal 4/9/2026.

  • #1878 di @kekubhai — aperta

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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.
Lingua principale
Twig
Stelle
330
Fork
212
Merge medio
12h 3m
PR unite (30g)
131

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di appwrite/sdk-generator

Tutte le issue di appwrite/sdk-generator

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.