Skip to content

Fix mint login guidance and write-token rules in the setup guide - #8306

Merged
ethanpalm merged 1 commit into
mainfrom
docs/setup-guide-fixes
Nov 5, 2026
Merged

ethanpalm merged 1 commit into
mainfrom
docs/setup-guide-fixes

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Nov 5, 2026 •

Copy link
Copy Markdown
Collaborator

Follow-up to #8214.

What changed

  • mint login: The guide said agents must never run it because it hangs. mint login opens a browser and waits for a localhost callback or a pasted code, so it completes on the person's own machine once they approve. It only stalls in cloud or remote sessions. The guide now lets agents run it locally in the background, and the person runs it in cloud or remote sessions. This also resolves the conflict with mint-instructions/new-site.mdx, which tells agents to run it.
  • Write token: The public docs site flow said "Run them" with no token rules. This restores the rules from auth.md: pass the token only as the per-command header, never in a remote URL, file, Git config, or message to the person. Rerun mint deploy if the token expires.
  • Stale pointer: auth.md has no "Allowed domains" section, so the cloud-session step now points to its network allowlist hosts.
  • Linked the bare auth.md URLs and the /ai/mintlify-mcp reference.

Not in this PR

  • The hosted-assistant branch only covers bases. It doesn't cover a public docs site.
  • /setup isn't indexed (no seo.indexing), so it's absent from llms.txt and search.
  • The Step 2 per-client config duplicates ai/mintlify-mcp.mdx, cli/commands.mdx, and the client guides.
  • Claims about third-party tool behavior (Claude Code auto mode, Antigravity, Grok Build, Codex output) aren't verified here.

@cdxker, please confirm the mint login change matches what you intended.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only edits to the setup guide with no runtime or security logic changes.

Overview
Updates setup.mdx so agent setup instructions match how mint login and deploy tokens actually work.

mint login: Replaces the blanket “don’t run it yourself” rule with local vs cloud/remote behavior—agents may run mint login in the background on the user’s machine and ask them to approve in the browser; in cloud or remote sessions the user runs mint login and add-domain locally. The CLI section repeats the same split and notes only add-domain needs login.

Deploy write token: After mint deploy, the guide now requires passing the token only as the per-command header from CLI output—never in remote URLs, files, Git config, or messages—and to rerun mint deploy if it expires (~10 minutes).

Links and pointers: Cloud sandbox network setup now points to auth.md’s allowlist wording (replacing a nonexistent “Allowed domains” section). Bare auth.md URLs and the Admin MCP reference use proper markdown links.

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

- Allow agents to run mint login on the person's own machine, matching
  mint-instructions/new-site.mdx and the CLI's browser callback flow
- Restore the write-token handling rules from auth.md
- Fix the stale "Allowed domains" pointer to auth.md
- Link bare URLs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Nov 5, 2026, 5:14 PM

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

@ethanpalm
ethanpalm merged commit 25cf835 into main Nov 5, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the docs/setup-guide-fixes branch November 5, 2026 19:36

This branch was successfully deployed

1 active deployment
staging — 6efbae9c Deployed Nov 5, 2026 by mintlify[bot]
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