Skip to content

Commit f8336ac

Browse files
committed
docs(readme): rename Act 1/2/3 to Step 1/2/3
"Act" read as theatrical; "Step" fits the causal flow (follow the signals from Step 1 to Step 2 or Step 3). Renames the three section headers and the three anchor links in the nav + signals table. No prose or code changes.
1 parent e01fa6b commit f8336ac

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717

1818
<p align="center">
1919
<a href="#quickstart">Quickstart</a> &bull;
20-
<a href="#act-1--trace-your-answers">Trace</a> &bull;
21-
<a href="#act-2--upgrade-data-quality">Upgrade Data Quality</a> &bull;
22-
<a href="#act-3--upgrade-retrieval">Upgrade Retrieval</a> &bull;
20+
<a href="#step-1--trace-your-answers">Trace</a> &bull;
21+
<a href="#step-2--upgrade-data-quality">Upgrade Data Quality</a> &bull;
22+
<a href="#step-3--upgrade-retrieval">Upgrade Retrieval</a> &bull;
2323
<a href="docs/trace.md">Trace Reference</a> &bull;
2424
<a href="SDK_TUTORIAL.md">Full Tutorial</a>
2525
</p>
@@ -49,7 +49,7 @@ That's it. You now know whether the answer was grounded, how much of your retrie
4949

5050
---
5151

52-
## Act 1 &mdash; Trace your answers
52+
## Step 1 &mdash; Trace your answers
5353

5454
Three lanes, one mental model. Pick the one that matches what your app is doing right now.
5555

@@ -120,8 +120,8 @@ The numbers above are not diagnostics. They are routing rules:
120120

121121
| Signal | Meaning | Next step |
122122
|---|---|---|
123-
| `band` amber/red, low `context_coverage_ratio` | The answer isn't grounded in what you retrieved. | **[Upgrade data quality](#act-2--upgrade-data-quality)** &mdash; your upstream documents are the bottleneck. |
124-
| High `context_unused_ratio`, `retrieval_waste_pct > 30%` | You retrieved the wrong chunks. | **[Upgrade retrieval](#act-3--upgrade-retrieval)** &mdash; your retriever is the bottleneck. |
123+
| `band` amber/red, low `context_coverage_ratio` | The answer isn't grounded in what you retrieved. | **[Upgrade data quality](#step-2--upgrade-data-quality)** &mdash; your upstream documents are the bottleneck. |
124+
| High `context_unused_ratio`, `retrieval_waste_pct > 30%` | You retrieved the wrong chunks. | **[Upgrade retrieval](#step-3--upgrade-retrieval)** &mdash; your retriever is the bottleneck. |
125125
| `session_signals.recommendation = "re_anchor"` / `"fresh_chat"` on the code lane | Session drift is compounding. | Reset the agent's context on the next turn. |
126126

127127
Full reference: [Trace docs](docs/trace.md) and [SDK tutorial &sect;18](SDK_TUTORIAL.md#18-direct-api-trace-groundedness--phantom-scoring).
@@ -142,7 +142,7 @@ async with AsyncLatence() as client:
142142

143143
---
144144

145-
## Act 2 &mdash; Upgrade data quality
145+
## Step 2 &mdash; Upgrade data quality
146146

147147
Trace is showing low coverage or amber/red bands? The model is rarely the problem. It's usually the upstream data: un-OCR'd PDFs, missing entities, unresolved references. The Latence **Data Intelligence Pipeline** cleans that in one call.
148148

@@ -196,7 +196,7 @@ See [docs/dataset_intelligence.md](docs/dataset_intelligence.md).
196196

197197
---
198198

199-
## Act 3 &mdash; Upgrade retrieval
199+
## Step 3 &mdash; Upgrade retrieval
200200

201201
If Trace keeps flagging a high `context_unused_ratio`, or the session rollup shows `retrieval_waste_pct > 30%`, your model isn't the problem &mdash; **your retrieval engine is shipping the wrong chunks**.
202202

0 commit comments

Comments
 (0)