docs: rewrite quickstart as agent-first connect, verify, deploy - #88
Conversation
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.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
jwfing
left a comment
There was a problem hiding this comment.
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/quickstartwalks 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...HEADis clean; I did not runmint devormint broken-linksbecause 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.
What
Rewrite
docs/quickstart.mdxas 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, andprompt.mdall 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:
Create Projectlands on the project's Quick Start page, which prints the setup command with the project id. Terminal alternative:setup agent --create.CodeGroupwithnpx -y insta@latest setup agent --project <project-id>and the console'sprompt.mdone-liner, verbatim fromfrontend/src/lib/agent-setup.ts. A Note points Windows, no-Node, and staging cases at/agents/setup.insta statuswith sample output, then the agent prompt from/agents/setup(insta status+insta_whoami), plusclaude mcp list./introductionand 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 usewrap.Verify
mint devrenders the page: five numbered steps, tab switching, accordion, cards, TOC entries. Screenshots checked at 1440px.mint broken-links: no broken links.insta setup agent --helpon insta 0.0.56 (--project <id>,--create [name]).insta-frontend: project creation routes to/projects/<id>/quick-start, setup prompt text matchessetupPrompt(), sign-up page offers GitHub, Google, and email.Summary by cubic
Rewrites
docs/quickstart.mdxto be agent-first, matching the setup flow the console, landing page, andprompt.mdall 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.