docs: normalize release truth before release-please cut#102
docs: normalize release truth before release-please cut#102PatrickSys merged 1 commit intomasterfrom
Conversation
Greptile SummaryThis is a documentation-only normalization PR that removes a manually-authored Confidence Score: 5/5Safe to merge — documentation-only changes with no runtime or test impact. All four changed files are documentation. The CHANGELOG removal correctly defers to release-please, the benchmark numbers are sourced from actual re-run artifacts, the README updates are accurate, and the capabilities doc reflects shipped behavior. No P0 or P1 findings; no runtime code or test paths are touched. No files require special attention.
|
| Filename | Overview |
|---|---|
| CHANGELOG.md | Removes the manually-authored v2.1.0 section so release-please can generate it from conventional commits; the remaining structure (## Unreleased → ## [1.9.0]) is correct for this workflow. |
| README.md | Removes two stale v2.0.0 references in the benchmark link text; changes are minimal and accurate. |
| docs/benchmark.md | Updates token-estimate numbers (~2× prior values), refreshes the comparator table to reflect two lanes now returning ok (but near-zero usefulness), and tightens gate-truth prose; all changes align with the PR description and honest-reporting rules. |
| docs/capabilities.md | Expands the search_codebase output column to document compact/full modes and adds two new pipeline steps (payload budgeting, full-mode chunk metadata); accurately reflects shipped behavior. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Feature commits on master] --> B{release-please}
B -->|generates| C[CHANGELOG.md v2.1.0 entry]
B -->|tags| D[v2.1.0 git tag]
C --> E[Public release]
D --> E
F[Manual 2.1.0 CHANGELOG section] -->|removed by this PR| G[Conflict avoided]
G --> B
H[Benchmark re-run artifacts] -->|updated by this PR| I[docs/benchmark.md]
J[Shipped compact/full API fields] -->|documented by this PR| K[docs/capabilities.md]
L[Stale v2.0.0 wording] -->|removed by this PR| M[README.md]
I --> E
K --> E
M --> E
Reviews (1): Last reviewed commit: "docs: normalize release truth before rel..." | Re-trigger Greptile
Summary
Normalizes the public release surface on master before the next Release Please cut.
What changed
Verification
Notes
Local pnpm test is red on this machine with inherited timeout/indexing failures, but current master GitHub Tests is green (run 24418025018). This branch does not change runtime code or tests; it only corrects stale public release truth before the release PR is refreshed.