Skip to content

auth: dedicated page for health checks and re-auth#365

Draft
dprevoznik wants to merge 2 commits into
mainfrom
hypeship/auth-health-checks-page
Draft

auth: dedicated page for health checks and re-auth#365
dprevoznik wants to merge 2 commits into
mainfrom
hypeship/auth-health-checks-page

Conversation

@dprevoznik
Copy link
Copy Markdown
Contributor

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:

  • the connection lifecycle (health check → auto-reauth → NEEDS_AUTH)
  • cadence + plan minimums for health_check_interval
  • behavior when session TTL is shorter than the check interval
  • can_reauth eligibility rules and what blocks auto-reauth
  • triggering manual re-auth via .login()
  • login failure codes (credentials_invalid, bot_detected, captcha_blocked, unsupported_auth_method) and how to recover from each
  • debugging via dashboard live view and record_session

FAQ 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

  • Mintlify preview renders the new page in the Auth nav between Profiles and FAQ
  • Anchor links from FAQ resolve (#when-a-login-fails, #triggering-re-auth-manually, #debugging-a-flaky-connection)
  • Cross-links to /auth/configuration#custom-proxy, /auth/credentials, /integrations/1password, /browsers/replays, /browsers/bot-detection/overview all resolve

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.
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 14, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 14, 2026, 2:18 AM

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

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

This PR only changes documentation content and Mintlify navigation: it adds auth/health-checks.mdx, moves existing FAQ detail into that dedicated page, updates one overview link, and adds the page to docs.json. I found no production code, infrastructure, auth logic, permissions, or prompt/model-instruction changes in the diff. No CODEOWNERS file was present, and the PR had no existing approvals in the metadata I checked.

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