Repository navigation
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
reviewed
Oct 31, 2026
| "pages": [ | ||
| "index", | ||
| "quickstart", | ||
| "setup", |
Collaborator
There was a problem hiding this comment.
since this is for agents, does it need to be in the sidebar nav? We can just have it indexed as a hidden page
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added
/setup, a step-by-step guide that tells an AI agent how to connect to Mintlify from whichever client it's running in. It moves here from the landing site.clank context (clickme)
Description
Moved the agent setup guide from mintlify.com/setup into the docs, so it's served at mintlify.com/docs/setup and /docs/setup.md.
setup.mdx: is the agent a hosted assistant or a coding agent; publishing with the CLI when nobody can sign in, asking first whether it's a knowledge base or a public docs site and whether git is already set up; ground rules;mint agent setup; per-client config for Claude Code, Cursor, Codex, Antigravity and Grok Build; verifying; the restart handoff; a first pagedocs.jsonTest Plan
npx -y mint@latest validatenpx -y mint@latest broken-linkscurl https://www.mintlify.com/docs/setup.md | headThe homepage prompt and
llms.txt/skill.mdin https://github.com/mintlify/landing/pull/911 point agents at this page.Verification
mint validate: build and validation passedmint broken-links: no broken linksvale setup.mdx: the remaining 19 errors are false positives from URLs, command names and quoted UI labels (claude.ai,/ai/mintlify-mcp,mcpServers, Authed). Em dashes now follow house style.Note
Low Risk
Documentation and navigation only; no application code, auth, or deployment logic changes in this repo.
Overview
Adds a new Set up Mintlify doc at
/setupby moving the agent-oriented setup guide from the landing site into the docs repo.The page is written for AI agents: it splits hosted assistants (relay connector steps) from coding agents (MCP OAuth, per-client config, verify, restart handoff). It also covers
mint deploy/ claim / domain when OAuth isn't possible (CI, cloud sessions),npx mint@latest agent setup --global, and client-specific notes for Claude Code, Cursor, Codex, Antigravity, and Grok Build.docs.jsonlistssetupin Get started, immediately after Quickstart.Reviewed by Cursor Bugbot for commit 545e478. Bugbot is set up for automated code reviews on this repo. Configure here.