Skip to content

docs: document custom proxy for managed auth connections#361

Open
masnwilliams wants to merge 2 commits into
mainfrom
hypeship/byo-proxy-managed-auth-docs
Open

docs: document custom proxy for managed auth connections#361
masnwilliams wants to merge 2 commits into
mainfrom
hypeship/byo-proxy-managed-auth-docs

Conversation

@masnwilliams
Copy link
Copy Markdown
Contributor

@masnwilliams masnwilliams commented May 13, 2026

Summary

  • Extract shared Connection Configuration out of auth/hosted-ui.mdx into a new top-level page auth/configuration.mdx. These options (Credentials, Custom Login URL, SSO/OAuth, Custom Proxy, Record Sessions, Post-Login URL, Updating) apply to all integration flows — hosted UI, React, and programmatic — and shouldn't be buried under one of them.
  • Strip the duplicated sections from auth/hosted-ui.mdx and auth/programmatic.mdx. Each integration page now keeps only flow-specific content and links out to the shared config page.
  • Add auth/configuration to the docs.json nav under the Auth group.
  • Update the one anchor link in auth/faq.mdx that pointed at the old hosted-ui section.

The Custom Proxy section (the original ask: BYO static IP / proxy for managed auth flows, CUS-210) is documented for the first time, covering attach on create, swap on update, and per-login override.

Test plan

  • Mintlify preview renders the new Connection Configuration page
  • Hosted UI / Programmatic pages link out and no longer carry the duplicated sections
  • 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 change that mainly reorganizes content and adds a new guide page; primary risk is broken/incorrect links or anchors.

Overview
Adds a new top-level auth/configuration.mdx page documenting shared Managed Auth connection options, including new guidance for pinning connections to a custom proxy (set on create, swap via update, and one-off override on .login()), plus session recording and other connection-wide settings.

Removes the duplicated “feature/configuration” sections from auth/hosted-ui.mdx and auth/programmatic.mdx and replaces them with links to the new configuration page; updates the FAQ link target accordingly and adds auth/configuration to the Auth navigation in docs.json.

Reviewed by Cursor Bugbot for commit f0439bd. 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.
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 verified the diff directly: it only adds/reorganizes Mintlify documentation under auth/*.mdx and adds one docs.json navigation entry. There are no production codepaths, infrastructure, auth logic, schema changes, or shared runtime systems modified. I also found no CODEOWNERS file and no existing approvals on the PR, so I’m approving.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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

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

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