infra: content lifecycle strategy
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- git, github-actions
- 领域
- devops, documentation, release
调研方向
首先阅读 sync-motoko.yml、update-syntax-grammars.yml、.sources/VERSIONS 以及 CLAUDE.md 中的子模块检查清单。梳理剩余的子模块,以及所请求的 ownership 和 review-policy 三个领域;当所需的工作流覆盖范围、CODEOWNERS 文件和有文档记录的周期都已定义时,即视为完成。
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- JavaScript
- 星标
- 4
- 派生
- 5
- 平均合并
- 1 天 6 小时
- 30 天内合并 PR
- 30
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
dfinity/developer-docs 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 55/100
dfinity/developer-docs#281 ·
-
难度 4/5 3-5 天 新手友好度 35/100
dfinity/developer-docs#279 ·
-
docs: cycle cost docs follow-up — ICP formula, worked example, instruction profiling, cost traps 未关闭
难度 4/5 3-5 天 新手友好度 68/100
dfinity/developer-docs#274 ·
-
documentation enhancement
难度 4/5 3-5 天 新手友好度 52/100
dfinity/developer-docs#232 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 65/100
dfinity/developer-docs#228 ·
查看 dfinity/developer-docs 的全部 Issue
相似的 Issue
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
apache/cloudstack#14222 ·
-
Browser Waiting for: Product Owner
难度 2/5 1-3 小时 新手友好度 85/100
getsentry/sentry-javascript#24577 · 1 条评论 ·
-
curation good first issue
难度 2/5 1-3 小时 新手友好度 88/100
amponce/archive-movie-browser#186 ·
-
light
难度 2/5 1-3 小时 新手友好度 85/100
aemdemos/patients-stryker#253 ·
-
难度 2/5 1-3 小时 新手友好度 86/100
clerk/javascript#9852 ·