Skip to content

docs: restructure agents Deploy section around surface × access mode - #118

Merged
Him188 merged 2 commits into
mainfrom
docs/deploy-restructure-main
Aug 6, 2026
Merged

docs: restructure agents Deploy section around surface × access mode#118
Him188 merged 2 commits into
mainfrom
docs/deploy-restructure-main

Conversation

@Him188

@Him188 Him188 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Retargets the Deploy restructure to main (previously landed on the stale agent-docs branch as #117 by mistake — main had already absorbed agent-docs via #116). Two commits:

1. call.analyzed webhook semantics sync — pending doc sync that was stranded on agent-docs: the event fires on every terminal analysis status, dedup key includes finished_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.

  • Overview rewritten as two independent decisions: where users meet your agent (widget / your own UI via SDKs / phone / custom client) and who may start sessions (public agents vs authenticated sessions, comparison table moved here). States explicitly that every browser surface supports both access modes.
  • authentication.mdxauthenticated-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, widget sessionTokenProvider, wire protocol).
  • Sidebar reordered to setup order: overview → versions-publishing → public-agents → authenticated-sessions → widget → web-sdk → react-sdk → protocol.
  • Mislink fixes: three pages cited the old Authentication page for "API key setup" (never covered there) — now point at api-reference/introduction or the console API-keys page; versions-publishing's "Automate via API" card pointed at the Deploy overview, now at the publish endpoint reference.
  • Wording: "mint/minted/minting" → "create" across agent docs.
  • CodeGroup cleanup: groups that tabbed different responsibilities (backend vs browser, draft-update vs publish, request vs response, distinct API operations) split into sequential blocks; tabs kept only for alternative implementations of the same action.

Verification

  • Both commits cherry-pick cleanly onto main (agents tree on main was identical to the restructure's base; docs.json had no divergence)
  • mint broken-links: no broken links under agents/
  • Prettier: all touched files pass

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Summary by CodeRabbit

  • Documentation
    • Reorganized authentication guidance around authenticated sessions, backend-issued tokens, access modes, and deployment options.
    • Updated documentation links, navigation, and added a redirect from the former authentication page.
    • Clarified webhook behavior for completed, skipped, and failed post-call analysis, including status handling and idempotency guidance.
    • Simplified API examples by removing unnecessary code-group wrappers.
    • Updated API key and publishing links to point directly to the relevant resources.

Him188 and others added 2 commits August 6, 2026 15:37
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>
@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hanabiaiinc 🔴 Failed Aug 6, 2026, 6:38 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@Him188
Him188 merged commit ecaffe8 into main Aug 6, 2026
5 of 7 checks passed
@Him188
Him188 deleted the docs/deploy-restructure-main branch August 6, 2026 06:38
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d93f3b3b-7a0b-41fd-b738-9cb783b527e3

📥 Commits

Reviewing files that changed from the base of the PR and between 9aa2454 and 8ae68de.

📒 Files selected for processing (22)
  • agents/build/configuration.mdx
  • agents/build/dynamic-variables.mdx
  • agents/build/knowledge-base.mdx
  • agents/build/time-timezone.mdx
  • agents/build/tools.mdx
  • agents/concepts.mdx
  • agents/deploy/authenticated-sessions.mdx
  • agents/deploy/overview.mdx
  • agents/deploy/protocol.mdx
  • agents/deploy/public-agents.mdx
  • agents/deploy/react-sdk.mdx
  • agents/deploy/versions-publishing.mdx
  • agents/deploy/web-sdk.mdx
  • agents/deploy/widget.mdx
  • agents/monitor/conversation-history.mdx
  • agents/monitor/post-call-analysis.mdx
  • agents/monitor/webhooks.mdx
  • agents/overview.mdx
  • agents/quickstart.mdx
  • agents/telephony/phone-numbers.mdx
  • api-reference/agent-errors.mdx
  • docs.json

📝 Walkthrough

Walkthrough

The PR updates authenticated-session guidance, separates deployment surfaces from access modes, revises analysis webhook behavior, updates documentation links, and removes several CodeGroup wrappers.

Changes

Documentation updates

Layer / File(s) Summary
Authenticated sessions and navigation
agents/deploy/authenticated-sessions.mdx, docs.json, agents/deploy/*.mdx, agents/build/*.mdx, api-reference/agent-errors.mdx
The documentation now describes backend-minted session tokens, authenticated sessions, token lifetime, request fields, and session ending. Navigation and related cards use the new page and a server icon.
Deployment surfaces and access modes
agents/deploy/overview.mdx
The overview separates deployment surfaces from access modes and adds comparison and selection tables.
Settled analysis webhook behavior
agents/monitor/webhooks.mdx, agents/monitor/post-call-analysis.mdx
The docs cover completed, skipped, and failed analysis events. Examples handle analysis.status and deduplicate rerun analyses using analysis.finished_at.
API links and code examples
agents/build/*, agents/quickstart.mdx, agents/telephony/phone-numbers.mdx, agents/deploy/versions-publishing.mdx, agents/overview.mdx, agents/concepts.mdx
API destinations and terminology are updated. Several API examples no longer use CodeGroup wrappers.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

  • fishaudio/docs#116: This PR revises documentation pages introduced by PR #116, including terminology, links, examples, and webhook behavior.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/deploy-restructure-main

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.

❤️ Share

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

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