docs: quickstart leads with prompts, CLI on the second tab - #92
Conversation
CTO feedback on PR #88: some steps had no prompt alternative and the prompt tab was not the default. Steps 2, 3 and 4 now each carry a Prompt / CLI code group with Prompt first, the intro says so up front, and the deploy step's collapsed block is labelled as the CLI path. Consistent tab titles let Mintlify carry the reader's Prompt or CLI choice across the page.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
There was a problem hiding this comment.
All reported issues were addressed across 1 file
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
jwfing
left a comment
There was a problem hiding this comment.
Summary The quickstart now defaults the Connect and Verify code groups to Prompt before CLI without introducing blocking issues.
Requirements context I used the PR #92 title/body, the linked PR #88 context, the checked-out diff, and repo docs including CONTRIBUTING.md, docs/agents/setup.mdx, docs/agents/mcp-server.mdx, docs/deploy/overview.mdx, and the public https://www.instacloud.com/prompt.md. The PR body is partly stale: it still says Step 2 and the intro gained prompt/CLI treatment, while later commits and the current generated PR summary describe the final checked-out state where Step 2 remains console plus CLI only. I reviewed the final checked-out page on that basis.
Findings
Critical
(none)
Suggestion
docs/quickstart.mdx:13-31- Step 2 says the console Quick Start page prints the setup command, but Step 3 now tells readers to copy the prompt or command from the console. If the console really shows both, mention both in Step 2; if it only shows the command, adjust Step 3 so readers are not looking for a console prompt that is not there. The fallback prompt is still available directly below, so this is not blocking.
Information
docs/quickstart.mdx:28-60- Software engineering: the MDX uses existing MintlifyCodeGrouppatterns, keeps consistentPrompt/CLItab titles for tab memory, andgit diff --check main...HEADis clean. I did not runmint devormint broken-linksbecause this review was constrained to read-only commands.docs/quickstart.mdx:30-71- Functionality: the prompt text for connecting matches the publicprompt.mdflow with a project id, and the verify step now presents the agent prompt before the direct CLI check while preserving the sample CLI output below.docs/quickstart.mdx:1-130- Security: no security-sensitive code, auth, SQL, dependencies, secrets, or PII handling changed.docs/quickstart.mdx:1-130- Performance: no runtime code or request path changed, so there are no performance findings.
Verdict Approved by the automated review rule: no Critical findings. This should be posted as a comment; human GitHub approval remains separate.
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/quickstart.mdx">
<violation number="1">
P3: This delta removes the step-2 Prompt tab, so the file no longer matches the PR title ("quickstart leads with prompts, CLI on the second tab"), the step-2 bullet in the description ("add a Prompt/CLI path for the skip-the-console flow"), and the Verification criteria ("steps 2–4 render Prompt/CLI tabs with Prompt selected by default"). Step 2 now renders a single standalone `bash` block with no tabs and no prompt alternative. The recent commit `bdae60d1` shows the removal was intentional, but the PR description, title, and verification checklist still describe the pre-walk-back state and should be updated (or the step-2 prompt restored) so the merged docs and the PR's stated goal agree.</violation>
</file>
Tip: Review your code locally with the cubic CLI to iterate faster.
Re-trigger cubic
| @@ -23,35 +23,43 @@ This guide takes you from no account to a coding agent deploying on InstaCloud. | |||
| </Step> | |||
There was a problem hiding this comment.
P3: This delta removes the step-2 Prompt tab, so the file no longer matches the PR title ("quickstart leads with prompts, CLI on the second tab"), the step-2 bullet in the description ("add a Prompt/CLI path for the skip-the-console flow"), and the Verification criteria ("steps 2–4 render Prompt/CLI tabs with Prompt selected by default"). Step 2 now renders a single standalone bash block with no tabs and no prompt alternative. The recent commit bdae60d1 shows the removal was intentional, but the PR description, title, and verification checklist still describe the pre-walk-back state and should be updated (or the step-2 prompt restored) so the merged docs and the PR's stated goal agree.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/quickstart.mdx, line 18:
<comment>This delta removes the step-2 Prompt tab, so the file no longer matches the PR title ("quickstart leads with prompts, CLI on the second tab"), the step-2 bullet in the description ("add a Prompt/CLI path for the skip-the-console flow"), and the Verification criteria ("steps 2–4 render Prompt/CLI tabs with Prompt selected by default"). Step 2 now renders a single standalone `bash` block with no tabs and no prompt alternative. The recent commit `bdae60d1` shows the removal was intentional, but the PR description, title, and verification checklist still describe the pre-walk-back state and should be updated (or the step-2 prompt restored) so the merged docs and the PR's stated goal agree.</comment>
<file context>
@@ -5,31 +5,21 @@ description: "Connect your coding agent to an InstaCloud project and deploy some
- Prefer to skip the console? Either of these also does the next step in the same run.
-
- <CodeGroup>
+ Prefer to stay in the terminal? Skip the console. This creates a project named after the current directory and links it in the same run:
- ```text title="Prompt" wrap
</file context>
What
Follow-up to #88 from CTO review: some quickstart steps had no prompt alternative, and where a prompt existed it sat behind the CLI tab. The page now leads with prompts on every step that has one, and the CLI is the second tab.
How
setupPrompt()without a project id, which has the agent ask create-or-link perprompt.md. The CLI issetup agent --create, unchanged.Only
docs/quickstart.mdxchanges.Verify
mint devat 1440px: steps 2, 3, 4 render Prompt / CLI tabs with Prompt selected by default, TOC unchanged, accordion and cards intact.mint broken-links: no broken links.frontend/src/lib/agent-setup.tsanddocs/agents/setup.mdx.Summary by cubic
Reworks the quickstart so steps 3 and 4 lead with prompts and the CLI is the second tab, instead of the CLI being the default and some steps having no prompt at all. Step 2 keeps its console-and-CLI flow without a prompt.
Written for commit 55e0d92. Summary will update on new commits.