Skip to content

Commit 4d5c76d

Browse files
anandgupta42claude
andcommitted
docs: [#849] address review feedback on validator docs
- validators.md: drop "session rollup" claim from telemetry section (only per-validator events are emitted today); make `checked` / `concurrency_limit` optional in the result-shape schema to match what the validators actually return on the no-models path - dbt-tools.md: mention both opt-in flags (ENABLED + SHADOW) and the zero-overhead default - skills.md: correct the auto-load placement docs (prepended BEFORE the available-skills listing, not appended after — placement was deliberate) - benchmark/ade-bench/README.md: add 'text' language to the directory tree code fence for markdownlint MD040 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent bc5bca6 commit 4d5c76d

4 files changed

Lines changed: 18 additions & 10 deletions

File tree

benchmark/ade-bench/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It deliberately does **not** ship the trace files, the per-trial result JSONs, t
66

77
## What's in this folder
88

9-
```
9+
```text
1010
benchmark/ade-bench/
1111
├── README.md ← you are here
1212
├── altimate_code_agent/ ← drop-in agent module for ade-bench

docs/docs/configure/skills.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,12 @@ description: ...
6262
---
6363
```
6464

65-
At session start, after the standard `<available_skills>` listing, every matched
66-
skill body is appended to the system prompt under:
65+
At session start, every matched skill body is prepended to the system prompt
66+
(BEFORE the standard `<available_skills>` listing — placement matters: putting
67+
the auto-loaded block first frames the bodies as binding "rules of the road"
68+
rather than background reference) under:
6769

68-
```
70+
```xml
6971
<auto_loaded_skill name="<skill-name>">
7072
... full skill body ...
7173
</auto_loaded_skill>

docs/docs/data-engineering/tools/dbt-tools.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,11 @@ validators** that fire automatically after the agent declares done. They run
333333
`altimate-dbt test` and `altimate-dbt schema-verify` against every model
334334
modified during the session and block "done" if anything failed.
335335

336-
This is **opt-in** today (`ALTIMATE_VALIDATORS_ENABLED=1`) — see the
337-
[Validators page](../validators.md) for the full reference, env var
338-
catalogue, performance characteristics, and the phased rollout plan.
336+
This is **opt-in** today via either `ALTIMATE_VALIDATORS_ENABLED=1`
337+
(enforcement mode — failing validators block "done" with synthetic
338+
retries) or `ALTIMATE_VALIDATORS_SHADOW=1` (telemetry-only mode — runs
339+
without blocking, useful for measuring "would have caught" rates). When
340+
neither flag is set the dispatch path is completely skipped and there
341+
is zero overhead. See the [Validators page](../validators.md) for the
342+
full reference, env var catalogue, performance characteristics, and
343+
the phased rollout plan.

docs/docs/data-engineering/validators.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ minute of wall time.
117117
## Telemetry
118118

119119
When validators run (either mode), they emit one
120-
`validator_check` event per applied validator plus a session rollup:
120+
`validator_check` event per applied validator:
121121

122122
```json
123123
{
@@ -156,11 +156,12 @@ When a validator runs, it returns:
156156
fixHint?: string // the body injected into the synthetic user turn
157157
details: {
158158
models_touched: number
159-
checked: number
160159
dbt_root: string | null
161160
session_id: string
162-
concurrency_limit: number
163161
elapsed_ms: number
162+
// present only when at least one model was touched:
163+
checked?: number
164+
concurrency_limit?: number
164165
// validator-specific extras:
165166
// dbt-tests-pass:
166167
passed?: number

0 commit comments

Comments
 (0)