Skip to content

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

Merged
Him188 merged 1 commit into
agent-docsfrom
docs/deploy-restructure
Aug 6, 2026
Merged

docs: restructure Deploy section around surface × access mode#117
Him188 merged 1 commit into
agent-docsfrom
docs/deploy-restructure

Conversation

@Him188

@Him188 Him188 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

The old Deploy overview presented a four-step "channel ladder" (widget → public → authenticated → phone) that conflated two orthogonal axes — clicking 3. Authenticated sessions landed on a page titled Authentication that re-explained both access modes, including a Public agents section duplicating its sibling 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, with the 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

  • mint broken-links: no broken links under agents/ (pre-existing temp/ template leftovers untouched)
  • grep -riE '\bmint(s|ed|ing)?\b' over agent docs: clean (Mintlify brand excluded)
  • 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.

- 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>
@Him188
Him188 merged commit 6ab2fde into agent-docs Aug 6, 2026
2 checks passed
@Him188
Him188 deleted the docs/deploy-restructure branch August 6, 2026 06:35
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a68cc6ff-6663-49d0-b404-706547ae1504

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

Him188 added a commit that referenced this pull request Aug 6, 2026
- 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>
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