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

オープン
#1,822 コメント 1 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@kekubhai がすでに取り組んでいます。

2026年9月4日 から。

  • #1878 @kekubhai による — オープン

評価

この issue はまだ評価されていません。

説明

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.
主要言語
Twig
スター
330
フォーク
212
平均マージ
12時間 3分
マージ済み PR(30日)
131

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

appwrite/sdk-generator のほかの issue

appwrite/sdk-generator の issue をすべて見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。