📚 Documentation: Add Vale linting for all generated docs and examples
I maintainer di solito rispondono entro 1 giorno
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
*.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.
- Lingua principale
- Twig
- Stelle
- 330
- Fork
- 212
- Merge medio
- 12h 3m
- PR unite (30g)
- 131
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di appwrite/sdk-generator
-
🐛 Bug Report: Execution.fromMap throws Bad state: No element when server doesn't return resourceType (pre-Sites serversForse di nuovo libera @Aakriti7-giti l’ha presa 79 giorni fa e non c’è nessuna pull request aperta. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
appwrite/sdk-generator#1858 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Generate Push by default for SDKs that already released itForse di nuovo libera @ChiragAgg5k l’ha presa 34 giorni fa e non c’è nessuna pull request aperta. Aperta
appwrite/sdk-generator#2043 · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 45/100
appwrite/sdk-generator#1996 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
appwrite/sdk-generator#1851 ·
I maintainer di solito rispondono entro 1 giorno
-
Dependency DashboardAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 15/100
appwrite/sdk-generator#1628 ·
I maintainer di solito rispondono entro 1 giorno