📚 Documentation: Add Vale linting for all generated docs and examples
メンテナーはふだん 1 日以内に返信
評価
この 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
*.mdfile underexamples/. - 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
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
appwrite/sdk-generator のほかの issue
-
🐛 Bug Report: Execution.fromMap throws Bad state: No element when server doesn't return resourceType (pre-Sites servers再び着手できるかも @Aakriti7-giti が 79 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
appwrite/sdk-generator#1858 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Generate Push by default for SDKs that already released it再び着手できるかも @ChiragAgg5k が 34 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
appwrite/sdk-generator#2043 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
appwrite/sdk-generator#1996 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
appwrite/sdk-generator#1851 ·
メンテナーはふだん 1 日以内に返信
-
Dependency Dashboardオープン
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
appwrite/sdk-generator#1628 ·
メンテナーはふだん 1 日以内に返信