Skip to content

docs: add AI setup agent prompt to quickstart - #6781

Merged
N43527 merged 3 commits into
mainfrom
nivedh/quickstart-setup-agent-prompt
Jul 28, 2026
Merged

docs: add AI setup agent prompt to quickstart#6781
N43527 merged 3 commits into
mainfrom
nivedh/quickstart-setup-agent-prompt

Conversation

@N43527

@N43527 N43527 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Brief description of what's being updated

Adding an AI prompt to set up users with their mintlify projects.

Closes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Documentation-only changes to onboarding copy and a new MDX snippet; no application or deployment logic is modified.

Overview
The quickstart now leads with an AI agent path: a top-of-page tip explains that users can paste a prompt so an agent handles account creation, deployment, and later skill/MCP setup, and the page renders the new SetupAgentPrompt snippet instead of the lighter skill/MCP-only block that used to sit before Before you begin.

snippets/setup-agent-prompt.mdx is new. It wraps a copyable Prompt (copy + Cursor actions) with a 15-step playbook: validate the user’s content source, install/update mint, login/signup and onboarding handoffs, clone the connected repo, merge or replace template content, mint dev preview, push to deploy, optional custom domain DNS, verify the live .mintlify.site URL, install the Mintlify skill and admin MCP, and clear “needs me” vs agent-owned steps plus failure handling.

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

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 28, 2026, 6:08 PM

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 28, 2026, 6:08 PM

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

Comment thread snippets/setup-agent-prompt.mdx Outdated
9. Preview with `mint dev` (`http://localhost:3000`). It blocks until stopped, so run it as a background task — verify the preview loads, then stop it before continuing.
10. Commit and push your changes. Mintlify deploys automatically on push.
11. If I want a custom domain, run `mint add-domain <domain>`. It prints the DNS records I need to add with my domain provider — hand those to me directly, since only I can configure them at my registrar.
12. Confirm my site is live: fetch `https://<subdomain>.mintlify.app` (find the subdomain via `mint status`) and confirm it loads, then give me the URL. Deploys take a few minutes after pushing — retry before treating a failed fetch as an error.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shoot... i used .app instead of .site.

Since it's super tiny, while you're making the edits would you mind including this change as well?

@ethanpalm ethanpalm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few changes for the prompt but looks good!

Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Comment thread snippets/setup-agent-prompt.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@N43527
N43527 merged commit 804051a into main Jul 28, 2026
6 checks passed
@N43527
N43527 deleted the nivedh/quickstart-setup-agent-prompt branch July 28, 2026 21:02
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.

3 participants