Skip to content

docs: shared connection configuration page for managed auth#361

Merged
masnwilliams merged 7 commits into
mainfrom
hypeship/byo-proxy-managed-auth-docs
May 14, 2026
Merged

docs: shared connection configuration page for managed auth#361
masnwilliams merged 7 commits into
mainfrom
hypeship/byo-proxy-managed-auth-docs

Conversation

@masnwilliams
Copy link
Copy Markdown
Contributor

@masnwilliams masnwilliams commented May 13, 2026

Summary

Restructures the managed auth docs so connection-level options live in one place, and documents the Custom Proxy option for the first time.

  • New page auth/configuration.mdx holding all the shared connection-level options: credentials, custom login URL, SSO/OAuth, custom proxy, session recording, post-login URL, and updates. These apply to every integration flow (hosted UI, React, programmatic), so they shouldn't live under one of them.
  • auth/hosted-ui.mdx and auth/programmatic.mdx slimmed down — each page now only covers its integration flow and links out to the shared config page.
  • auth/react.mdx had no mention of these options at all; added a pointer so React users discover them.
  • Added auth/configuration to docs.json nav under Auth.
  • Documents the Custom Proxy option (the original ask: BYO static IP / proxy for managed auth flows, CUS-210). Covers attach on create, swap on update, per-login override, and is explicit about exit-IP stability per proxy type (ISP/datacenter static, residential rotating, custom BYO for fully customer-controlled static).
  • Copy cleanup: dropped internal "running connection workflow" phrasing in favor of user-observable behavior; simplified the session-recording description.

Test plan

  • Mintlify preview renders the new Connection Configuration page in nav
  • Hosted UI / React / Programmatic pages link out to the shared page
  • Cross-links from auth/faq.mdx resolve to the new anchors
  • Code samples compile against the current SDK shape

Note

Low Risk
Low risk documentation-only restructure; main risk is broken links/anchors or nav placement changes in Mintlify.

Overview
Adds a new shared auth/configuration.mdx page that centralizes Managed Auth connection-level options (credential saving/auto-reauth, custom login_url, SSO allowed_domains, custom proxy usage, record_session + replay_id, post_login_url, and auth.connections.update).

Updates the Hosted UI and Programmatic guides to remove duplicated configuration sections and link to the new page, adds the same pointer to the React guide, and adjusts the FAQ’s session-recording cross-link. Exposes the new page in the docs.json Auth navigation.

Reviewed by Cursor Bugbot for commit 507b1d8. Bugbot is set up for automated code reviews on this repo. Configure here.

Add a Custom Proxy section to the hosted UI page covering attach on
create, swap on update, and per-login override. Sharpen the proxy row
in the programmatic update table with a link to the new section.
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 13, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 13, 2026, 4:07 PM

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

Connection-level options — credentials, custom login URL, SSO/OAuth,
custom proxy, session recording, post-login URL, and updates — apply
equally to hosted UI, React, and programmatic flows. Move them into
auth/configuration.mdx and link from each integration page so the
options aren't buried under one flow.
cursor[bot]
cursor Bot approved these changes May 13, 2026
ISP/datacenter are static; residential rotates per connection; custom
(BYO) is the only way to guarantee a fully customer-controlled static
IP. Reflect this in the Custom Proxy section instead of implying all
proxies pin to the same IP.
Drop the start/stop lifecycle detail and just say the entire browser
session is recorded.
Replace 'running connection workflow' with user-facing copy that
describes the observable behavior (next health check or reauth uses
the new value).
@masnwilliams masnwilliams marked this pull request as ready for review May 13, 2026 17:42
@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

Reason: PR only modifies documentation files (auth configuration docs) with no changes to API endpoints or Temporal workflows.

To monitor this PR anyway, reply with @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I verified the diff directly: this only adds/reorganizes Mintlify documentation under auth/*.mdx and adds one docs.json navigation entry. There are no production codepaths, infrastructure changes, auth/permission logic changes, schema changes, or shared runtime systems modified.

I also found no CODEOWNERS file. The PR is already approved at the current head commit, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I re-evaluated the current diff directly. The PR only adds/reorganizes Mintlify documentation under auth/*.mdx and adds one docs.json navigation entry; the latest update adds a short auth/react.mdx cross-link to the shared connection configuration page. There are no production codepaths, infrastructure changes, auth/permission logic changes, schema changes, or shared runtime systems modified.

I found no CODEOWNERS file. The PR is already approved and the update does not increase risk, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I re-evaluated the latest PR diff directly at the current head. The changes are limited to Mintlify documentation under auth/*.mdx plus one docs.json navigation entry for the new shared connection configuration page. The newest update only simplifies wording around session recording; it doesn’t modify production codepaths, infrastructure, auth/permission logic, schemas, or shared runtime systems.

I found no CODEOWNERS file. The PR is already approved, and the current update does not increase risk, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I reviewed the current diff directly. The PR is limited to Mintlify documentation changes in auth/*.mdx plus one docs.json navigation entry for the new shared connection configuration page. It moves existing managed-auth configuration guidance into a shared docs page and adds copy/cross-links for custom proxy and session recording behavior.

I found no production codepath changes, infrastructure changes, auth/permission logic changes, schema changes, prompt/instruction-file changes, or shared runtime system changes. I also found no CODEOWNERS file in the repository.

The PR is already approved, and this update does not increase risk, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Comment thread auth/configuration.mdx Outdated
@masnwilliams masnwilliams changed the title docs: document custom proxy for managed auth connections docs: shared connection configuration page for managed auth May 13, 2026
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I reviewed the current diff directly. The changes are limited to Mintlify documentation under auth/*.mdx plus one docs.json navigation entry for the new shared connection configuration page. The update moves connection-level managed-auth guidance into a shared page and adjusts links/copy around proxy and session recording behavior.

I found no production codepath changes, infrastructure changes, auth/permission logic changes, schema changes, prompt/instruction-file changes, or shared runtime system changes. I also found no CODEOWNERS file in the repository.

The PR is already approved, and this update does not increase risk, so I’m not submitting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Co-authored-by: Eric Feng <ehfeng@users.noreply.github.com>
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

I re-evaluated the current diff directly at head 507b1d8. The PR is limited to Mintlify documentation changes: a new auth/configuration.mdx page, small auth-doc cross-link/copy updates, and one docs.json navigation entry.

I found no production codepath changes, infrastructure changes, auth/permission logic changes, schema changes, prompt/instruction-file changes, or shared runtime system changes. I also found no CODEOWNERS file in the repository.

GitHub currently reports the PR as approved, and this update does not increase risk, so I’m not submitting another approval or revoking the existing one.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@masnwilliams masnwilliams merged commit d0e28ed into main May 14, 2026
4 checks passed
@masnwilliams masnwilliams deleted the hypeship/byo-proxy-managed-auth-docs branch May 14, 2026 00:23
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.

2 participants