Repository navigation
docs(router): reframe matching review as a durable reference - #547
Merged
Merged
Conversation
Rename matching-stability-review.md -> matching-and-lazy-discovery.md and rewrite it from a point-in-time v1 *review* (Pass-1/2-landed changelog, implementation plan, next actions, per-finding M/C/R status catalogs, workflow write-ups) into a durable *reference*: how matching works (trie canonical, regex latent; one shared buildPerRouterTrie), the dev/prod contract table (updated for the unified builder), the matching invariants with rationale (C1/C5/C7/C19/C8/M3/M4 folded in as design decisions), the measured-and-accepted lazy-include cost tradeoffs (LP1/LP3/LP4 with numbers + the bench), the tests that pin each, and a short optional/not-v1 list. The changelog half is already captured by git history + the merged PRs, so it is dropped. Finding IDs (C1/C5/C19/M3/M4/LP1/LP3/LP4) are kept as decision labels so the code-comment cross-references still resolve. - git mv preserves history. - Updated the 6 references to the new path: docs/README.md (nav entry reworded) and 5 code comments (manifest.ts, lazy-includes.ts, trie-regex-parity.test.ts, lazy-include-perf.test.ts, lazy-include-cost.bench.ts). Docs + comments only; no behavior change. typecheck / unit 3383 / lint / format green.
Collaborator
Author
|
Follow-on commits on this branch (both
So this PR now: renames + reframes the matching doc, warms its tone, and records the voice guide it exemplifies. |
3 tasks done
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
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.
What
Reframes the matching/lazy-discovery internal doc from a point-in-time v1 stability review into a durable architecture & accepted-tradeoffs reference, and renames it to match:
docs/internal/matching-stability-review.md→docs/internal/matching-and-lazy-discovery.mdDocs + code-comments only — no behavior change. Committed with
[skip ci].Why
The review framing had served its purpose: the v1 matching-stability work is done (#535, #537–#541, #544–#546). What was left was ~60% transient process scaffolding — "Pass 1/2 landed" changelog, implementation plan, next actions, the per-finding
M/C/Rstatus catalogs, and write-ups of the multi-agent workflows we ran. That half is already captured by git history and the merged PRs, so as a current-state doc it would only rot. The remaining ~40% is genuinely durable and worth keeping as reference.What the reference keeps
buildPerRouterTriefor both dev and prod.visitPrefixNoderow).joinPrefixnormalization (C5), find-match cache clone (C7), shared-staticPrefixomission (C19), leaf-vs-non-leaf precompute (C8), trailing-slash modes (M3).vitest bench lazy-include-costartifact, framed as "do not re-litigate without re-running the bench."Mechanics
git mv(history preserved; the large rewrite means git shows it as add+delete in the diff, but--followtracks it).C1/C5/C19/M3/M4/LP1/LP3/LP4) kept as decision labels so the 5 code-comment cross-references still resolve.docs/README.md(nav entry reworded) + 5 code comments (manifest.ts,lazy-includes.ts,trie-regex-parity.test.ts,lazy-include-perf.test.ts,lazy-include-cost.bench.ts). Verified no stale references to the old filename remain.Test plan
[skip ci]