docs: fix README links left dangling by the design.md restructuring - #167
Merged
Merged
Conversation
PR #157 cut design.md from 1500+ lines to a ~200-line index and deleted migration-plan.md, but never touched README.md, which still pointed at migration-plan.md and design.md's old §3/§6/§8/§9/§11/§12 section numbers -- none of which exist anymore. Repoints at the new per-layer docs (l1-query-language.md through l5-physical-plan.md) and this README's own "Consumption modes" section where that's where the content actually lives now; drops the migration-plan.md reference entirely since the file's gone and nothing replaced it. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Beyond the dangling doc links, the README had drifted from the actual codebase in several ways: - "sketch" framing (query->sketch pipeline, sketch algebra, sketch IR) predates the summary-bound-IR renaming docs/l4-summary-bound-ir.md already uses -- aligned the descriptive language to "summary" while leaving real identifiers (asap-sketch, SummaryKind, SummaryExpr) as-is. - L4's binding pass and the summary-vs-exact accuracy decision (issue #98) were described as "stub"/"planned" -- #98 has been closed for a while; bind.rs/boundary.rs/cost_model.rs are real, landed code. - asap-plan's Cargo.toml depends on asap-sketch (needs the L4 types for binding), not "asap-ir alone" as the isolation-wins bullet claimed. - asap-sketch gained exec.rs (the serving-time SummaryExecutor trait + execute() walker, ~700 lines) since the crate table and directory tree were last written -- both still described it as "type definitions only". - asap-e2e now also depends on asap-sketch/asap-plan (l4_binding.rs tests lowering through to L4), not just asap-frontend-promql. - Refreshed the ~LOC column against current `wc -l` per crate -- asap-sketch and asap-plan had roughly 4x and 7x more code than listed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
#157 cut
design.mdfrom 1500+ lines to a ~200-line index and deletedmigration-plan.md, but never touchedREADME.md, which still pointed atmigration-plan.mdanddesign.md's old §3/§6/§8/§9/§11/§12 section numbers — none of which exist anymore.Changes
l1-query-language.mdthroughl5-physical-plan.md) and this README's own "Consumption modes" section, where that content actually lives now.migration-plan.mdreference entirely — the file's gone and nothing replaced it.docs/design.md §5.2reference in the directory-structure comment block, pointing it atdocs/l5-physical-plan.mdinstead.Test plan
grep -n "§\|migration-plan" README.md— no matches.🤖 Generated with Claude Code