infra: content lifecycle strategy

Aperta
#120 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
git, github-actions

Direzione di ricerca

Inizia leggendo sync-motoko.yml, update-syntax-grammars.yml, .sources/VERSIONS e la checklist dei sottomoduli in CLAUDE.md. Mappa i sottomoduli rimanenti e le tre aree richieste relative all’ownership e alle policy di revisione; il lavoro è completato quando sono definiti la copertura necessaria dei workflow, il file CODEOWNERS e una cadenza documentata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Context

Define how docs stay fresh as upstream sources evolve. This covers change detection, sync automation, and freshness ownership.

Current state

Automated:

  • Motoko pages: sync-motoko.yml — weekly, detects new caffeinelabs/motoko releases and opens a PR with synced content already committed
  • Motoko + Candid grammars (Shiki): update-syntax-grammars.yml — weekly, tracks dfinity/vscode-motoko releases and opens a PR with updated TextMate grammars

Established conventions:

  • Every content page carries an <!-- Upstream: hand-written | sync from | informed by --> comment (decision: 2026-03-12)
  • Every submodule bump PR must follow the checklist in CLAUDE.md (per-submodule diff review, affected page updates, bump notice comments on open PRs)
  • .sources/VERSIONS tracks current pinned versions for release-pinned submodules

Not yet in place:

  • No automated change detection for the remaining 13+ submodules (icp-cli, cdk-rs, motoko-core, icskills, examples, icp-js-sdk-docs, candid, response-verification, chain-fusion-signer, papi, ic-pub-key, internetidentity, icp-cli-recipes, icp-cli-templates)
  • No CODEOWNERS file — no defined ownership per section
  • No documented review cadence or staleness policy

Remaining questions

  1. Submodule change detection: Build a workflow similar to sync-motoko.yml for release-pinned submodules — check latest tag against .sources/VERSIONS, open a bump PR or issue when behind. Main/master-pinned submodules are harder (no release signal); a weekly diff summary issue may be more practical.
  2. CODEOWNERS: Define section-level ownership (e.g. chain-fusion guides → chain-fusion team, Rust CDK pages → SDK team).
  3. Review cadence: Document a spot-check schedule for hand-written pages that are informed by upstream sources.

Output

  • Automated bump detection workflow(s) for release-pinned submodules
  • CODEOWNERS file
  • Staleness / review cadence documented in .docs-plan/decisions.md or CONTRIBUTING.md
Lingua principale
JavaScript
Stelle
4
Fork
5
Merge medio
1g 6h
PR unite (30g)
30

Guida per i contributori

Apri la guida per i contributori

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 dfinity/developer-docs

Tutte le issue di dfinity/developer-docs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.