Skip to content

docs: rewrite quickstart as agent-first connect, verify, deploy - #88

Merged
CarmenDou merged 6 commits into
mainfrom
docs/quickstart-agent-first
Sep 3, 2026
Merged

docs: rewrite quickstart as agent-first connect, verify, deploy#88
CarmenDou merged 6 commits into
mainfrom
docs/quickstart-agent-first

Conversation

@CarmenDou

@CarmenDou CarmenDou commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

What

Rewrite docs/quickstart.mdx as an agent-first quickstart. The old page was a CLI walkthrough (install, login, project create, services add, secrets bind, deploy, branch) that never mentioned the one-line setup the console, the landing site, and prompt.md all lead with. The new page follows that flow.

Only this page changes. Navigation, redirects, and other pages are untouched. The CLI-only content is dropped on purpose, the manual command sequence survives in a collapsed block.

How

Five steps plus Next steps:

  1. Create an account. One line, sign up and sign in links to the console.
  2. Create a project. Console Create Project lands on the project's Quick Start page, which prints the setup command with the project id. Terminal alternative: setup agent --create.
  3. Connect your agent. CodeGroup with npx -y insta@latest setup agent --project <project-id> and the console's prompt.md one-liner, verbatim from frontend/src/lib/agent-setup.ts. A Note points Windows, no-Node, and staging cases at /agents/setup.
  4. Verify. insta status with sample output, then the agent prompt from /agents/setup (insta status + insta_whoami), plus claude mcp list.
  5. Deploy something. Tabs for "I have an app" and "Start from scratch" with the prompts already used on /introduction and the landing agent pages. The four CLI commands the agent runs sit in an Accordion. Template fallback via the console's Add Service.

Next steps cards: Postgres, Storage, Compute, MCP tools, descriptions copied from each page's own frontmatter.

Step titles use titleSize="h2" so the right-hand table of contents lists all five. Long prompt code blocks use wrap.

Verify

  • mint dev renders the page: five numbered steps, tab switching, accordion, cards, TOC entries. Screenshots checked at 1440px.
  • mint broken-links: no broken links.
  • CLI flags checked against insta setup agent --help on insta 0.0.56 (--project <id>, --create [name]).
  • Console behaviour checked in insta-frontend: project creation routes to /projects/<id>/quick-start, setup prompt text matches setupPrompt(), sign-up page offers GitHub, Google, and email.
  • Two screenshots are still to come (console Quick Start panel, Add Service template picker). Placeholders are MDX comments and render nothing.

Summary by cubic

Rewrites docs/quickstart.mdx to be agent-first, matching the setup flow the console, landing page, and prompt.md all lead with. The old page was a CLI walkthrough that never mentioned the one-line setup; the new one moves from create account → create project → connect agent → verify → deploy. Only this page changes, and the manual CLI commands survive in a collapsed block.

Written for commit 625fc51. Summary will update on new commits.

Review in cubic

The page was a CLI walkthrough (install, login, project, services, deploy, branch) that
never mentioned the one-line setup the console, landing and prompt.md all lead with. It
now mirrors that flow in four steps: create a project in the console, connect the agent
with `setup agent --project <id>` or the prompt.md one-liner, verify with `insta status`
plus an `insta_whoami` call from the agent, then hand the deploy to the agent. The manual
command sequence stays in a collapsed block, and the CLI-only content is dropped.
@mintlify

mintlify Bot commented Sep 3, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
instacloud 🟢 Ready View Preview Sep 3, 2026, 8:13 PM

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

@jwfing jwfing left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Summary The agent-first quickstart is coherent and reviewable; I found no blocking issues.

Requirements context I based intent on the PR title/description: rewrite docs/quickstart.mdx into a five-step agent-first flow, preserve manual deploy commands in a collapsed block, and leave navigation/redirects/other pages untouched. Repo context used: CONTRIBUTING.md says docs/ is the Mintlify source; docs/agents/setup.mdx grounds setup behavior; docs/deploy/overview.mdx grounds Dockerfile deploy behavior; the Next steps targets exist. I also spot-checked current external docs/URLs used by the page: signup, signin, prompt.md, Mintlify Steps, and Mintlify code block wrap.

Findings

Critical
(none)

Suggestion

  • docs/quickstart.mdx:72-113, docs/introduction.mdx:41-42 - The quickstart no longer covers creating a first branch, but the Introduction still says /quickstart walks through “your first branch.” Since the branch section was intentionally removed, update that Introduction sentence or add a branch pointer from quickstart to avoid stale cross-page guidance.
  • docs/quickstart.mdx:6, docs/quickstart.mdx:40, docs/agents/setup.mdx:20-25 - The quickstart says “any other” coding agent and says the MCP server is registered for every coding agent on the machine. The setup page narrows MCP registration to Claude Code and supported config-file agents whose config directory exists, while broader agents may only get skills. Consider changing the quickstart wording to “supported agents” or linking the caveat near verification.

Information

  • docs/quickstart.mdx:1-128 - Software engineering: this is a single-file docs/MDX change using existing Mintlify patterns. git diff --check origin/main...HEAD is clean; I did not run mint dev or mint broken-links because the review was constrained to read-only commands and those tools may write local cache/output files.
  • docs/quickstart.mdx:1-128 - Functionality: the new page covers account creation, project creation, agent connection, verification, deploy prompts, manual commands, and Next steps as described. Internal links in the changed file point to existing docs files.
  • docs/quickstart.mdx:1-128 - Security: no security-relevant code, dependencies, auth, SQL, or secret handling changed; I did not find leaked secrets or tokens in the new examples.
  • docs/quickstart.mdx:1-128 - Performance: no runtime or request-path code changed, so no performance-relevant findings.

Verdict Approved by the automated review rule: no Critical findings. The bot should post this as a comment; human GitHub approval remains separate.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

@jwfing jwfing left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM - approved.

@CarmenDou
CarmenDou merged commit d5b4701 into main Sep 3, 2026
3 of 4 checks passed
@CarmenDou
CarmenDou deleted the docs/quickstart-agent-first branch September 3, 2026 20:45
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