docs: restructure agents Deploy section around surface × access mode - #118
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Split the "channel ladder" into two independent decisions: where users meet the agent (widget / own UI / phone / custom client) and who may start sessions (public agents vs authenticated sessions) - Rename authentication.mdx -> authenticated-sessions.mdx with redirect; page refocused as the backend session-creation reference, public-agent duplication removed, client-agnostic token table added - Reorder Deploy sidebar: access-mode pages before surface pages - Fix mislinks: API-key setup references now point at api-reference/introduction or the console; versions-publishing "Automate via API" points at the publish endpoint - Replace "mint" wording with "create" across agent docs - Split CodeGroups that tabbed different responsibilities (backend vs browser, draft-update vs publish, request vs response, distinct API operations) into sequential code blocks Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (22)
📝 WalkthroughWalkthroughThe PR updates authenticated-session guidance, separates deployment surfaces from access modes, revises analysis webhook behavior, updates documentation links, and removes several ChangesDocumentation updates
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Retargets the Deploy restructure to
main(previously landed on the staleagent-docsbranch as #117 by mistake — main had already absorbed agent-docs via #116). Two commits:1.
call.analyzedwebhook semantics sync — pending doc sync that was stranded onagent-docs: the event fires on every terminal analysis status, dedup key includesfinished_at.2. Deploy section restructure. The old overview presented a four-step "channel ladder" (widget → public → authenticated → phone) conflating two orthogonal axes; clicking 3. Authenticated sessions landed on a page titled Authentication that re-explained both access modes, duplicating the Public agents page.
authentication.mdx→authenticated-sessions.mdx(redirect added in docs.json): now the pure backend session-creation reference — token flow, request fields, response, token lifetime, force-end, errors — plus a client-agnostic table showing where the token goes per surface (Web SDK, React SDK, widgetsessionTokenProvider, wire protocol).api-reference/introductionor the console API-keys page; versions-publishing's "Automate via API" card pointed at the Deploy overview, now at the publish endpoint reference.Verification
mint broken-links: no broken links underagents/🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by CodeRabbit