docs(planning): sweep stale references after PR #14 / PR #15#16
Merged
Conversation
Reconcile the planning docs with the implementation-phase changes
that landed after the original design walkthrough.
- idea-honing.md Q9: add a "Superseded during implementation"
annotation pointing to the new training-knob model from PR #14
(compression-dict-min-training-keys / -max-training-keys /
compression-training-buffer-size). The original walkthrough text
is preserved below the annotation for historical record.
- detailed-design.md §7.1 transparency-mode example: replace
--compression-dict-first-training-keys-count (removed in PR #14)
with --compression-dict-min-training-keys.
- detailed-design.md §2.12 heading: "Advanced knobs (12)" → "(11)".
Off-by-one count introduced when PR #14 reshuffled the table.
- summary.md: add a new "What changed during implementation"
section between the walkthrough section and the plan summary,
capturing the three substantive post-walkthrough refinements
(PR #14 training rewrite, PR #15 R2.5.6 read-hot gap, PR #13
QSBR plumbing).
Doc-only; no code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Housekeeping pass to reconcile the planning docs with the implementation-phase changes that landed after the original design walkthrough. No code changes.
Findings & fixes
idea-honing.mdQ9compression-dict-first-training-keys-count). Annotation pattern matches Q6's existing "Superseded by review" pattern — preserves historical text below for traceability.detailed-design.md§7.1 transparency-mode example--compression-dict-first-training-keys-count 10→--compression-dict-min-training-keys 10detailed-design.md§2.12 headingsummary.md(new section)summary.mdplan-summary sectionFiles NOT touched (verified consistent)
implementation/plan.md— S1 sub-tasks already use new training-model terminology; status reflects merged PRs accurately.idea-honing.mdQ6 — already documents the policy-aware filter refinement and droppedcompression-settle-secondsknob.detailed-design.md§2.5/§2.6/§4.4/§4.6 — recent updates from PR [S2.4] Compression worker pool #13, [design] Revise training trigger and sampling caps (R2.3.5, R2.3.6) #14, docs(design): R2.5.6 — read-hot compressed-value gap acknowledgment #15 are internally consistent.research/*.md— historical inputs to the design, predate all changes; describe Valkey internals / ZSTD APIs that haven't shifted.rough-idea.md— source issue, immutable.DESIGN_TODO.mdandpr-feedback.json— PR Inline compression design (initial draft) #1 review-task artifacts kept for historical traceability.Diff stat
Independent of in-flight PR #15 (touches different sections).