Skip to content

docs(guides): anchor the agents verify snippet in a debug route - #3763

Merged
kojiwakayama merged 1 commit into
mainfrom
fix/dx-agents-verify-route
Aug 16, 2026
Merged

kojiwakayama merged 1 commit into
mainfrom
fix/dx-agents-verify-route

Conversation

@kojiwakayama

@kojiwakayama kojiwakayama commented Aug 16, 2026 •

Copy link
Copy Markdown
Contributor

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/generate snippet 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.ts plus the curl to 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). Full tests/docs/ 56/56 and validate-public-docs.ts clean.

Summary by CodeRabbit

  • Documentation

    • Updated agent verification instructions with a temporary debug endpoint example.
    • Added a curl command for testing agent responses.
    • Clarified that the debug endpoint should be removed before deployment.
  • Tests

    • Updated documentation checks to validate the new verification guidance.

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.
@github-actions

Copy link
Copy Markdown

📦 Client bundle boundary

Entrypoint Modules Source size Server leaks
src/index.client.ts 320 1904 KiB ✅ 0

A server module in a client graph aborts hydration in the browser. New leaks fail CI; known leaks are tracked in scripts/lint/client-bundle-baseline.json to burn down.

@coderabbitai

coderabbitai Bot commented Aug 16, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b208be07-8168-4409-957c-40621672e872

📥 Commits

Reviewing files that changed from the base of the PR and between a67821a and cc5ef36.

📒 Files selected for processing (2)
  • docs/guides/agents.md
  • tests/docs/guide-contracts.test.ts

Included review availability: Your plan includes up to 3 reviews per rolling hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The agent guide now uses a temporary /api/debug/agent GET route to invoke the assistant agent, return JSON, and verify the response with curl. The contract test checks the new documentation snippets.

Changes

Agent debug-route guidance

Layer / File(s) Summary
Document and validate agent route guidance
docs/guides/agents.md, tests/docs/guide-contracts.test.ts
The guide adds a temporary GET route that returns { text } as JSON and documents a localhost curl command. The contract test requires the route and curl snippets.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to cc5ef

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: kwakayama

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes moving the agents verification snippet into a temporary debug route.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/dx-agents-verify-route

Comment @coderabbitai help to get the list of available commands.

@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 16, 2026
Merged via the queue into main with commit aeb2568 Aug 16, 2026
34 checks passed
@kojiwakayama
kojiwakayama deleted the fix/dx-agents-verify-route branch August 16, 2026 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant