Skip to content

docs: establish canonical DiskSage product requirements - #315

Draft
seonghobae wants to merge 122 commits into
feat/physical-cache-reclaim-v1from
codex/canonical-prd
Draft

docs: establish canonical DiskSage product requirements#315
seonghobae wants to merge 122 commits into
feat/physical-cache-reclaim-v1from
codex/canonical-prd

Conversation

@seonghobae

@seonghobae seonghobae commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Purpose

Canonical product/public documentation owner for DiskSage. Keep PRD, architecture summary, public README/index, standards traceability, operator guidance, and docs/product-technical-gap-baseline.md aligned with live runtime ownership without moving runtime authority into documentation.

Current authority — 2026-09-07 KST

Code-current projection

docs/product-technical-gap-baseline.md is updated on this branch at 069ceffb.... It no longer reports #344 as pending or #339/#303 as 19 commits behind. It records #344 exact GREEN, ordinary non-force owner adoption by #339/#303, their fresh non-terminal consumer Tests, #212's remaining dependency, #264's canonical CodeQL blocker, and the remaining Windows native-handle / same-object deletion / durable recovery gaps.

#344 retains descriptor-relative create-new authority and fail-closed existing-record replacement. Final visible-record reads are bounded at encoded.len()+1, raw trailing Unix / destinations fail before filesystem authority is acquired, public private-JSON serialization enforces the 8 MiB encoded budget during serialization, and the production core shim does not expose the legacy materialize-then-check JSON writer as a crate-level capability. Exact hosted Test on current #344 is GREEN.

#339/#303 now inherit current #344 through ordinary ancestry, but owner GREEN is not consumer GREEN. Their current exact Tests must terminate successfully on unchanged heads before any downstream restack or merge. #212 remains held until post-adoption #339 GREEN.

#264 remains separately blocked by the canonical .github CodeQL metadata-binding owner path. Windows private publication/replacement parity, exact-source existing-record replacement, broader same-object Trash/future irreversible deletion, durable journal, crash/power-loss recovery, and undo remain open P0 work under #170/#342. macOS durability claims must distinguish exercised fsync behavior from stronger F_FULLFSYNC semantics.

Documentation contract

DiskSage runtime domain truth stays with runtime owners. Optional ecosystem capabilities consume released/versioned owner contracts through ports/ACLs; docs do not authorize mutable cross-repository source coupling, cross-service SQL, model override of deterministic safety evidence, or irreversible purge. Live GitHub refs/checks remain more authoritative than a dated projection.

Keep Draft until applicable current-head documentation/review/ruleset gates and upstream protected-lineage prerequisites are satisfied. No self-approval, force-push, destructive rebase, gate weakening, or stale-head readiness claim.

@coderabbitai

coderabbitai Bot commented Aug 29, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

제품 계약, 아키텍처 색인, gap baseline을 추가하거나 갱신했습니다. README와 GitHub Pages 문서를 재구성했습니다. 캐시 purge를 읽기 전용 검토로 제한하고, 비가역 작업의 향후 승인 기준을 정의했습니다.

Changes

제품 계약 및 추적 기준선

Layer / File(s) Summary
제품 계약 및 추적 기준선
AGENTS.md, ARCHITECTURE.md, CHANGELOG.md, docs/product-technical-gap-baseline.md
에이전트 지침과 문서 색인을 추가했습니다. PRD를 제품 계약의 정본으로 명시했습니다. gap baseline의 역할과 변경 로그를 갱신했습니다.

승인 후보 및 purge 검증 경계

Layer / File(s) Summary
승인 후보 및 purge 검증 경계
docs/PRD.md, docs/architecture/adr/0002-cache-cleanup-is-per-item-evidence-bound.md, docs/development/cache-cleanup-operator-runbook.md
proven-cache Trash purge를 읽기 전용 검토로 제한했습니다. 직접 자식, symlink-free 재검증, journal 증거, 후보 식별과 동시 변경 방지에 대한 기준을 정의했습니다. 레거시 비가역 실행 경로를 운영 지원 대상에서 제외했습니다.

제품 범위 및 운영 문서

Layer / File(s) Summary
제품 범위 및 운영 문서
README.md, docs/index.md
README를 제품 범위, 안전 경계, 공급자 경계, 고객 상태, 개발 검증 절차 중심으로 재작성했습니다. GitHub Pages 색인을 추가하고 관련 문서와 릴리스 경계를 연결했습니다.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Merge Risk: 🟡 Moderate · up to 1ebfd

This documentation PR changes the published safety contract, but its canonical requirements still describe irreversible purge while the operator guidance calls that capability unsupported and the executable remains able to perform it; that inconsistency could lead to unsafe operator action. The runbook also lists preview fields that are not currently emitted. The PR is not merge-ready until these contracts are aligned or explicitly accepted by the responsible owners.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 57.14% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 28 functions across 4 files. (2 skipped: … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 제목은 docs: 접두사를 사용하고, docs/PRD.md를 정식 제품 요구사항으로 확립하는 PR의 주요 변경을 정확하고 간결하게 설명합니다.
Full details: Docstring Coverage

Explanation

Docstring coverage is 57.14% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 28 functions across 4 files. (2 skipped: 2 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/canonical-prd

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

devin-ai-integration[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

@seonghobae seonghobae added the documentation Improvements or additions to documentation label Sep 1, 2026 — with ChatGPT Codex Connector
devin-ai-integration[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

@seonghobae seonghobae added priority: medium Normal-priority or P2 work status: needs-review Open pull request requiring current-head review or checks labels Sep 1, 2026 — with ChatGPT Codex Connector
devin-ai-integration[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@seonghobae seonghobae added the status: blocked Blocked by conflict, dependency, or required prerequisite label Sep 2, 2026 — with ChatGPT Codex Connector
@seonghobae seonghobae removed the status: needs-review Open pull request requiring current-head review or checks label Sep 2, 2026
devin-ai-integration[bot]

This comment was marked as resolved.

Copy link
Copy Markdown
Contributor Author

Code-current projection correction for the next docs commit (2026-09-07 KST):

docs/product-technical-gap-baseline.md and this PR body currently retain older heads/status wording and therefore need a source-doc update; this comment records the verified correction without claiming the checked-in baseline is already current.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work status: blocked Blocked by conflict, dependency, or required prerequisite type: docs Documentation, ADR, PRD, or technical writing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant