Skip to content

docs: quickstart leads with prompts, CLI on the second tab - #92

Merged
CarmenDou merged 4 commits into
mainfrom
docs/quickstart-prompt-first
Sep 4, 2026
Merged

docs: quickstart leads with prompts, CLI on the second tab#92
CarmenDou merged 4 commits into
mainfrom
docs/quickstart-prompt-first

Conversation

@CarmenDou

@CarmenDou CarmenDou commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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

  • Intro states the two ways up front: prompt first, CLI on the second tab.
  • Step 2 (Create a project) gains a Prompt / CLI code group for the skip-the-console path. The prompt is the console's setupPrompt() without a project id, which has the agent ask create-or-link per prompt.md. The CLI is setup agent --create, unchanged.
  • Step 3 (Connect your agent) swaps tab order so the prompt is default.
  • Step 4 (Verify) turns the two separate blocks into one Prompt / CLI code group, sample output stays below.
  • Step 5 accordion is retitled "CLI: the commands the agent runs" so the prompt/CLI split is visible.
  • All code groups use the same tab titles ("Prompt", "CLI"), so Mintlify remembers the reader's choice across the page.

Only docs/quickstart.mdx changes.

Verify

  • mint dev at 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.
  • No em dashes or semicolons in prose. Prompt texts unchanged from frontend/src/lib/agent-setup.ts and docs/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.

  • The intro states prompts start at step 3.
  • Consistent "Prompt"/"CLI" tab titles let Mintlify remember the reader's choice across the page.
  • The deploy step's accordion is retitled "CLI: the commands the agent runs" to make the prompt/CLI split visible.

Written for commit 55e0d92. Summary will update on new commits.

Review in cubic

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.
@mintlify

mintlify Bot commented Sep 4, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
instacloud 🟢 Ready View Preview Sep 4, 2026, 11:26 PM

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

@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.

All reported issues were addressed across 1 file

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/quickstart.mdx Outdated
Comment thread docs/quickstart.mdx Outdated

@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 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 Mintlify CodeGroup patterns, keeps consistent Prompt / CLI tab titles for tab memory, and git diff --check main...HEAD is clean. I did not run mint dev or mint broken-links because this review was constrained to read-only commands.
  • docs/quickstart.mdx:30-71 - Functionality: the prompt text for connecting matches the public prompt.md flow 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.

@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.

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

Comment thread docs/quickstart.mdx
@@ -23,35 +23,43 @@ This guide takes you from no account to a coding agent deploying on InstaCloud.
</Step>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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>

@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 72d8982 into main Sep 4, 2026
3 checks passed
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