dfinity / dfinity/developer-docs
infra: content lifecycle strategy
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 5
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 30
Description
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 newcaffeinelabs/motokoreleases and opens a PR with synced content already committed - Motoko + Candid grammars (Shiki):
update-syntax-grammars.yml— weekly, tracksdfinity/vscode-motokoreleases 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/VERSIONStracks 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
- Submodule change detection: Build a workflow similar to
sync-motoko.ymlfor 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. - CODEOWNERS: Define section-level ownership (e.g. chain-fusion guides → chain-fusion team, Rust CDK pages → SDK team).
- Review cadence: Document a spot-check schedule for hand-written pages that are
informed byupstream sources.
Output
- Automated bump detection workflow(s) for release-pinned submodules
CODEOWNERSfile- Staleness / review cadence documented in
.docs-plan/decisions.mdorCONTRIBUTING.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading sync-motoko.yml, update-syntax-grammars.yml, .sources/VERSIONS, and the submodule checklist in CLAUDE.md. Map the remaining submodules and the three requested ownership and review-policy areas; done means the required workflow coverage, CODEOWNERS file, and documented cadence are all defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions
- Domain
- devops, documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100