Skip to content

Add copy-prompt blocks to CLI install and agent guides#6638

Merged
ethanpalm merged 2 commits into
mainfrom
mintlify/3b321f95
Jul 21, 2026
Merged

Add copy-prompt blocks to CLI install and agent guides#6638
ethanpalm merged 2 commits into
mainfrom
mintlify/3b321f95

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Extends the "Copy prompt" pattern (the <Prompt> component already used once in the Quickstart) to the highest-value pages where a reader is likely to hand setup to an AI agent instead of typing commands themselves:

  • cli/install.mdx — three new prompts: install the CLI, scaffold a new project with mint new, update the CLI. Each prompt wraps the surrounding command examples with instructions the agent can execute end-to-end (verify Node version, run the install, share mint --version output, handle the common sudo fallback, etc.).
  • ai/skillmd.mdx — prompt that tells an agent to run npx skills add <url>, list the installed skills, and summarize the product's capabilities so the user knows what the agent can now do.
  • guides/claude-code.mdx and guides/codex.mdx — reuse the existing snippets/skill-mcp-prompt.mdx (the same prompt shown on the Quickstart) right after the install step. Users can paste it into the just-started Claude Code / Codex session to load the Mintlify skill + MCP into the agent's context.

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

Generated by Mintlify Agent.

Requested by: ethan@mintlify.com via Slack
Mintlify session: slack_1784251231.104309_C04P7GNDRRS


Note

Low Risk
Documentation-only MDX additions with no runtime, auth, or data-path changes.

Overview
Extends the existing <Prompt> copy-to-agent pattern to setup-heavy docs so readers can hand workflows to an AI instead of typing commands.

On cli/install.mdx, adds a tip plus prompts that walk an agent through global CLI install (Node version check, npm/pnpm install, mint --version, permissions/sudo) and scaffolding a project with non-interactive mint new, listing outputs, and starting mint dev. Each block is wrapped in {/* vale off */} / {/* vale on */}.

On ai/skillmd.mdx, adds a prompt for running npx skills add <url>, listing installed skills, summarizing capabilities, and surfacing frontmatter constraints.

On guides/claude-code.mdx and guides/codex.mdx, imports snippets/skill-mcp-prompt.mdx (same as Quickstart) with a tip to paste it after starting the CLI so the session loads the Mintlify skill and MCP endpoints.

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

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 17, 2026, 4:10 PM

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

@mintlify

mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 17, 2026, 4:10 PM

@mintlify

mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 17, 2026, 4:06 PM

@mintlify

mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 17, 2026, 4:06 PM

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

@ethanpalm
ethanpalm merged commit f2f4d9a into main Jul 21, 2026
6 checks passed
@ethanpalm
ethanpalm deleted the mintlify/3b321f95 branch July 21, 2026 00:36
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