Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

infra: content lifecycle strategy

Đang mở
  • Có gì không ổn?
#120 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
git, github-actions
Lĩnh vực
devops, documentation, release

Hướng nghiên cứu

Bắt đầu bằng cách đọc sync-motoko.yml, update-syntax-grammars.yml, .sources/VERSIONS và checklist submodule trong CLAUDE.md. Lập bản đồ các submodule còn lại và ba lĩnh vực ownership và chính sách review được yêu cầu; được xem là hoàn tất khi phạm vi bao phủ workflow cần thiết, tệp CODEOWNERS và chu kỳ được ghi chép đầy đủ đều đã được xác định.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
JavaScript
Star
4
Fork
5
Merge trung bình
21 giờ 49 phút
Pull request đã merge (30 ngày)
28

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của dfinity/developer-docs

Tất cả issue của dfinity/developer-docs

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.