Skip to content

Dedupe builder README cache prose into Dockerfile comments#16

Merged
zengsipei merged 1 commit into
mainfrom
dedupe-builder-readme-cache
Jul 8, 2026
Merged

Dedupe builder README cache prose into Dockerfile comments#16
zengsipei merged 1 commit into
mainfrom
dedupe-builder-readme-cache

Conversation

@zengsipei

Copy link
Copy Markdown
Owner

Closes #12

Implements ADR 0004 decision 2: the builder README's cache-persistence section no longer duplicates the Dockerfile's Rebuildable Cache wiring block.

Changes (devimage-build/README.md only, +5/−42)

  • 缓存持久化 section: the volume-subdir → home-path mapping tree and the mkdir/ln -sf code blocks are removed; the section shrinks to loss-cost framing (Rebuildable Cache), a link to ADR 0003, and a pointer to the Dockerfile cache-wiring block as the sole owner (ADR 0004 decision 2).
  • FAQ "如何添加新的缓存目录": the literal two-step Dockerfile recipe is replaced by "one-block edit in the Dockerfile's Rebuildable Cache wiring block, follow the existing entries" — says that it's a one-block edit without repeating the block's contents (per the issue's key-interface note).
  • 用户配置 bullet: the (npm / pnpm / pip / poetry / vscode-extensions) tool enumeration — another copy that would rot — is collapsed into an anchor link to the cache section.

Acceptance criteria

  • No mapping enumeration nor literal cache link command duplicates remain (grep -E 'cache-volumes|ln -sf|mkdir -p' on the README returns nothing)
  • Remaining cache section links to ADR 0003 and points at the Dockerfile block
  • scripts/check-release-contract.sh passes

Out of scope untouched: .devcontainer/ consumer README, Dockerfile wiring, no docs-vs-code sync checker.

The cache-persistence section shrinks to loss-cost framing + links: the
volume-subdir → home-path mapping enumeration and the literal mkdir/ln -sf
recipes are owned by the Dockerfile's Rebuildable Cache wiring block
(ADR 0004 decision 2, aligning ADR 0002's ownership table with ADR 0003 §6).

Closes #12
@zengsipei zengsipei merged commit ec87ff3 into main Jul 8, 2026
2 checks passed
@zengsipei zengsipei deleted the dedupe-builder-readme-cache branch July 8, 2026 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Dedupe builder README cache-layout prose into the Dockerfile comments

1 participant