diff --git a/docs/tutorial-end-to-end.md b/docs/tutorial-end-to-end.md index 45b03b9f..4bcc01cf 100644 --- a/docs/tutorial-end-to-end.md +++ b/docs/tutorial-end-to-end.md @@ -892,10 +892,11 @@ Use AgentOps for the repo-side follow-through: `.agentops/governance/redteam-plan.md`; keep raw payloads/results in the approved secure system. 3. If you use ASSERT or Agent Control Specification, add reviewed artifacts to - the repo or CI artifacts and point AgentOps at them: + the repo or CI artifacts and point AgentOps at them. In tutorials, keep this + as a metadata-only showcase unless you already have an approved ASSERT run: ```yaml - assert_path: .assert/evaluation-policy.yaml + assert_path: .agentops/governance/assert-evidence.md acs_path: acs.yaml redteam_path: .agentops/governance/redteam-plan.md ``` diff --git a/docs/tutorial-prompt-agent-quickstart.md b/docs/tutorial-prompt-agent-quickstart.md index e69dc7c7..afa3fe73 100644 --- a/docs/tutorial-prompt-agent-quickstart.md +++ b/docs/tutorial-prompt-agent-quickstart.md @@ -844,6 +844,44 @@ only to metric names that appear in the azd run output, and regenerate the recip with `agentops eval init --force`. Do not use placeholder rubric names in the quickstart path. +### Optional: showcase ASSERT evidence + +ASSERT is useful in the tutorial as **release evidence**, not as an AgentOps-run +execution step. Run ASSERT in its owning tool, keep the approved policy or result +summary in the repo or CI artifact store, and point AgentOps at that artifact so +Doctor and the evidence pack can cite its status and hash. + +For a safe tutorial/demo path, add only reviewed metadata. Do not paste raw +adversarial prompts, secrets, or customer data into the repo. + +```powershell +New-Item -ItemType Directory -Force .agentops\governance | Out-Null +@' +# ASSERT evidence + +Status: reviewed +Source: +Scope: Travel Agent release readiness +Notes: ASSERT execution remains in the owning ASSERT workflow; AgentOps records +this artifact as release evidence only. +'@ | Set-Content -Encoding utf8 .agentops\governance\assert-evidence.md +``` + +Then reference it from `agentops.yaml`: + +```yaml +assert_path: .agentops/governance/assert-evidence.md +``` + +When you later run: + +```powershell +agentops doctor --workspace . --evidence-pack +``` + +the release evidence includes the ASSERT path, status, and SHA-256 hash without +claiming that AgentOps executed ASSERT. + ## 11. Generate the PR + dev deploy workflows > **Pipeline ownership.** This tutorial uses `agentops workflow generate`