Skip to content

docs(eval): use a fact id that exists in the scenario example - #6863

Merged
kovtcharov-amd merged 1 commit into
amd:mainfrom
ityashag:docs/eval-scenario-fact-id
Nov 6, 2026
Merged

kovtcharov-amd merged 1 commit into
amd:mainfrom
ityashag:docs/eval-scenario-fact-id

Conversation

@ityashag

@ityashag ityashag commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes the fact_id in the custom scenario example, which names a fact that doesn't exist in the corpus manifest.

Why

A reader who copies the Step 3 YAML gets a scenario pointing at a fact that isn't there, and nothing reports an error. eval/corpus/manifest.json lists cfo_approval_threshold for budget_2025, not cfo_threshold.

Linked issue

Closes #3460

Changes

  • Changes cfo_threshold to cfo_approval_threshold in both turns of the example in docs/guides/eval-scenarios.mdx.

Test plan

  • grep -n "cfo_threshold" docs/guides/eval-scenarios.mdx: no matches.
  • Compared the example with eval/corpus/manifest.json: budget_2025 has total_budget, engineering_budget and cfo_approval_threshold.
  • Docs site build: not run. This only changes a value inside a code block.

Evidence

N/A: this is a docs-only change. It doesn't touch the Agent UI, MCP tools, CLI behavior or the HTTP API.

  • Agent exposed in the Agent UI: N/A
  • MCP tools / servers: N/A
  • CLI: N/A
  • HTTP API / REST: N/A

Checklist

  • I have linked a GitHub issue above (Closes #N / Fixes #N / Refs #N).
  • I have described why this change is being made, not just what changed.
  • I have run linting and tests locally (python util/lint.py --all, pytest tests/unit/). Not run: this PR only changes one .mdx file and no code.
  • I have attached real-world evidence matched to the surface I changed (see Evidence above), or marked each surface N/A.
  • I have updated documentation if user-visible behavior changed (see CONTRIBUTING.md). This PR is the documentation change.

The example named cfo_threshold, but the budget_2025 manifest entry calls it cfo_approval_threshold.

Closes amd#3460
@github-actions github-actions Bot added the documentation Documentation changes label Nov 6, 2026
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Verdict: Approve

The custom-scenario example in the eval guide now uses a fact id that really exists in the corpus, so readers who copy it get a valid scenario. I checked the manifest: budget_2025 defines cfo_approval_threshold, and the old id cfo_threshold isn't used anywhere else in the docs, hub packages or eval corpus. Nothing else needs changing.

Real-world evidence

N/A: this is a docs-only change with no runnable surface, so the verdict rests on static review alone.

🔍 Technical details

Issues found: none.

Strengths

  • Both turns of the example were fixed together, so the scenario stays internally consistent.
  • Every other fact_id / fact_ids in docs/guides/eval-scenarios.mdx (q3_revenue, yoy_growth, price_a, price_b, employee_count, ceo_outlook, pto_days, remote_work) also resolves in eval/corpus/manifest.json, so this was the only broken reference in the guide.

@kovtcharov-amd
kovtcharov-amd added this pull request to the merge queue Nov 6, 2026
Merged via the queue into amd:main with commit d26517b Nov 6, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The flagship copy-paste example names a fact id that does not exist in the corpus manifest

2 participants