docs(guides): anchor the agents verify snippet in a debug route - #3763
Conversation
The agents guide's verify step said 'invoke it from server code' without saying where that code lives; a first-time reader has no obvious home for it. The tools guide next door already solves this with a throwaway debug route, so mirror that shape: the getAgent/generate snippet becomes app/api/debug/agent/route.ts plus the curl to hit it, with the same 'remove before deploying' note. Walked against published v0.1.1239: this exact route answered end-to-end on the first try. The page contract now pins the route path and the curl command.
📦 Client bundle boundary
A server module in a client graph aborts hydration in the browser. New leaks fail CI; known leaks are tracked in |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan includes up to 3 reviews per rolling hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe agent guide now uses a temporary ChangesAgent debug-route guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change anchors the verification example in a debug route and adds its curl command; no actionable merge-blocking risk remains after normal checks and review. Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Problem
DX dogfood of the published agents guide (veryfront@0.1.1239) found the "Verify it worked" step says invoke it from server code and then shows a bare
getAgent/generatesnippet with no stated home. A first-time reader doesn't know whether it belongs in a route, a script, or a task. The tools guide next door already solves this with a throwaway debug route.Fix
Mirror the tools guide's shape: the snippet becomes
app/api/debug/agent/route.tsplus thecurlto hit it, with the same "remove before deploying" note. This exact route was walked during the dogfood run against 0.1.1239 and answered end-to-end on the first try.Regression coverage
guide-contracts.test.ts: the page contract now requires the route path and the curl command (written first, failed for the right reason). Fulltests/docs/56/56 andvalidate-public-docs.tsclean.Summary by CodeRabbit
Documentation
curlcommand for testing agent responses.Tests