auth: dedicated page for health checks and re-auth#365
Conversation
Consolidates scattered FAQ entries on health check cadence, can_reauth eligibility, manual re-auth, login failure codes, and debugging into a single Health Checks & Re-Auth page. FAQ entries now defer to the new page with a short summary and link. Overview links to it from the Session monitoring bullet.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Rename page to Connection Lifecycle (auth/connection-lifecycle.mdx) to match the page's scope beyond just health checks - Fix Start-Up minimum interval (15 min -> 20 min) to match StartupMinHealthCheckIntervalSeconds in the API - Move nav position to right after Configuration, before Credentials - Slim Debugging section to the per-login override; link out to Connection Configuration for the connection-wide record_session flag - Add a pointer from overview's How It Works to the lifecycle page so the integration loop and runtime loop don't compete - Update cross-links in faq + overview to the new path
|
overall i like the direction — same restructure pattern as #361 (pull scattered FAQ content into a stable URL, leave one-liners + links in the FAQ). a few things to consider before merge: bug to fix — Start-Up minimum is wrongThe cadence table says Start-Up minimum is 15 minutes. The real value in const StartupMinHealthCheckIntervalSeconds = 1200 // 20 minThe original FAQ had the same wrong number — it got carried forward. Worth fixing in this PR. reframe as "Connection Lifecycle""Health Checks" is narrower than what the page covers — health-check cadence is one of ~six sections (lifecycle, cadence,
Reading order: overview → pick integration → configure → understand how it runs/breaks. nav placementCurrently placed between Profiles and FAQ. I'd put it right after sequencing with #361The page links to mild duplication — debugging sectionThe Debugging a flaky connection section covers minor — overlap with overview's "How It Works"
verified
|
There was a problem hiding this comment.
Stale comment
Risk assessment: Very Low
The current diff only changes documentation and Mintlify navigation: it adds
auth/connection-lifecycle.mdx, shortensauth/faq.mdxby linking to the dedicated page, updatesauth/overview.mdxlinks/copy, and adds the new page todocs.json. I found no production code, infrastructure, auth implementation, permissions, or prompt/model-instruction changes.The PR is already approved, so I’m leaving the existing approval in place and not re-approving.
Sent by Cursor Automation: Assign PR reviewers
|
Firetiger deploy monitoring skipped This PR didn't match the auto-monitor filter configured on your GitHub connection:
Reason: This PR modifies documentation/content pages, not kernel API endpoints or Temporal workflows; please opt in manually if deploy monitoring is needed. To monitor this PR anyway, reply with |
There was a problem hiding this comment.
Stale comment
Risk assessment: Very Low
The synchronized diff only changes documentation and Mintlify navigation: it adds
auth/connection-lifecycle.mdx, shortensauth/faq.mdxby linking to that dedicated page, updates a small amount ofauth/overview.mdxcopy/linking, and adds the new page todocs.json.I found no production code, infrastructure, auth implementation, permissions, schema, or prompt/model-instruction changes. There’s no
CODEOWNERSfile in this checkout, and the PR is already approved, so I’m leaving the existing approval in place and not re-approving.Sent by Cursor Automation: Assign PR reviewers
There was a problem hiding this comment.
Risk assessment: Very Low
The current diff only changes documentation content and Mintlify navigation: it adds auth/connection-lifecycle.mdx, replaces expanded FAQ sections with links to that page, updates one overview link/copy section, and adds the new page to docs.json. I found no production code, infrastructure, auth implementation, permissions logic, or prompt/model-instruction changes.
No CODEOWNERS file is present in the repository metadata I checked. The PR is already approved, so I’m leaving that approval in place and not re-approving.
Sent by Cursor Automation: Assign PR reviewers
masnwilliams
left a comment
There was a problem hiding this comment.
lgtm - absolutely money


Summary
There's no single home for managed auth connection health checks / re-auth troubleshooting today — the content is scattered across the FAQ and lightly touched in Configuration. This adds a dedicated Health Checks & Re-Auth page under Auth.
The new page consolidates:
NEEDS_AUTH)health_check_intervalcan_reautheligibility rules and what blocks auto-reauth.login()credentials_invalid,bot_detected,captcha_blocked,unsupported_auth_method) and how to recover from eachrecord_sessionFAQ entries that were the de-facto reference for this material are trimmed to a one-liner that links into the new page, so the FAQ stays focused on Q&A and the deep content has a stable URL. Overview's "Session monitoring" bullet also links to the new page.
Test plan
#when-a-login-fails,#triggering-re-auth-manually,#debugging-a-flaky-connection)/auth/configuration#custom-proxy,/auth/credentials,/integrations/1password,/browsers/replays,/browsers/bot-detection/overviewall resolveNote
Low Risk
Low risk documentation-only change that reorganizes Managed Auth guidance; main risk is broken links/anchors or navigation ordering issues.
Overview
Introduces a new
auth/connection-lifecycle.mdxpage that consolidates guidance on connection health checks, auto-reauth eligibility (can_reauth), manual.login()re-auth, failure codes/recovery, and debugging/recording.Trims overlapping FAQ sections down to short link-outs to the new page, updates
auth/overview.mdxto reference it for session monitoring/runtime behavior, and adds the new page to the Auth navigation indocs.json.Reviewed by Cursor Bugbot for commit b2db039. Bugbot is set up for automated code reviews on this repo. Configure here.