docs: establish canonical DiskSage product requirements - #315
docs: establish canonical DiskSage product requirements#315seonghobae wants to merge 122 commits into
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthrough제품 계약, 아키텍처 색인, gap baseline을 추가하거나 갱신했습니다. README와 GitHub Pages 문서를 재구성했습니다. 캐시 purge를 읽기 전용 검토로 제한하고, 비가역 작업의 향후 승인 기준을 정의했습니다. Changes제품 계약 및 추적 기준선
승인 후보 및 purge 검증 경계
제품 범위 및 운영 문서
Estimated code review effort: 3 (Moderate) | ~25 minutes Merge Risk: 🟡 Moderate · up to 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)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation 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.)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Code-current projection correction for the next docs commit (2026-09-07 KST):
|
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.mdaligned with live runtime ownership without moving runtime authority into documentation.Current authority — 2026-09-07 KST
main:0e90f9cebadbd7f59606baaec4ca1d2f178c899a;3e33229b4157a084a1985a1c7e952f98a64f25e3; Test/Release/Security/SAST are terminal success while CodeQL remains failed at the canonical.githublive-PR metadata-binding owner path;736da6db1fb0918d998b3f4d240c63936c91b11d, exact Test34050767861terminal success on Ubuntutest101533855512, Windowswindows-home-resolution101533855641, and Ubuntullm-engine-build101533855661;f8ddd5444b09496c893063dc806a95d478163cea; exact Test34053995024is current and non-terminal;5164b847ed95661a4b40a69c66b520639f58d970; exact Test34054137067is current and non-terminal;7f51536f22dc3605edfb8db2269c8f37a1dd4079and is held until post-adoption security: reject unknown OAuth connection authority fields #339 earns unchanged-head terminal GREEN;069ceffb99612db5a6792efc3da59a3ed8012727; exact Test34054582580is current and non-terminal.Code-current projection
docs/product-technical-gap-baseline.mdis updated on this branch at069ceffb.... 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
.githubCodeQL 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 exercisedfsyncbehavior from strongerF_FULLFSYNCsemantics.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.