Skip to content

docs(get-started): sign new users up with connect --signup - #236

Merged
connorckong merged 2 commits into
mainfrom
connorckong/setup-prompt-signup
Nov 19, 2026
Merged

connorckong merged 2 commits into
mainfrom
connorckong/setup-prompt-signup

Conversation

@connorckong

Copy link
Copy Markdown
Collaborator

Summary

Plain volcano connect opens the browser sign-in page (/projects/<id>/auth/hosted?action=device). With CLI 0.84 that page offers GitHub, Google, or email and password sign-in. It has no way to create an account by email, so a new user who wants email sign-up has nowhere to go.

  • get-started/quickstart.md: steps 2 and 3 (volcano signup, projects create, use) become one step, volcano connect --signup, plus the homepage's agent prompt. Existing users are pointed to the log-in link on the sign-up page or plain volcano connect.
  • cli/connect.md: the opening example shows --signup for new users and plain connect for existing ones, with the homepage prompt in place of "paste both lines into a coding agent". Step 1 now says what the sign-in page offers.

Companion change on the homepage: Kong/volcano-web, same branch name.

Evidence

Agent bench runs on production, 2026-11-19, a new user signing up by email, ending in a deployed hello-world app:

  • Homepage hero prompt (connect --signup): Claude Code 4/4, Codex 3/4. Codex's one failure came with a slow user (+3 min): it ended its turn before sign-in finished.
  • The old "Start with one prompt" text (plain connect): 0/2. Both runs stopped at the sign-in page.

Validation

  • pnpm lint:docs content/get-started and content/cli: OK
  • node scripts/check-links.mjs: OK
  • pnpm build: OK

🤖 Generated with Claude Code

Plain `volcano connect` opens the browser sign-in page, which can't create
an account by email. Point the quickstart and the connect page's opening
example at `volcano connect --signup` for new users, give the homepage's
agent prompt, and note what the sign-in page offers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

AI review: no P0-P2 findings

Reviewed 98ae4f3. Run log

Docs-only change. New users are now sent to volcano connect --signup, with a coding-agent prompt for the same command, in the quickstart and on the CLI connect page. Existing users are told to run plain volcano connect. Risk is low. All three earlier findings are fixed at this head: the connect page's example no longer runs both commands, the quickstart now says to cd into the directory connect prints, and it explains the --email fallback when the git email is missing or private.

Not checked: The AI review read the diff, the code, and the PR's text; it ran no tests or builds and read nothing outside this repository.

  • Unverified product claims: the sign-in page offers GitHub, Google, and email/password, can't create an account by email, and the signup page has a log-in link.
  • Whether the agent prompt matches the companion homepage change in Kong/volcano-web word for word wasn't checked.
  • Confirm the released CLI and production account pages match the documented signup behavior, email fallback, sign-in methods, and signup-page log-in link.

Human review: not needed

Comment thread content/get-started/quickstart.md Outdated
This prefills your email, opens the browser signup flow, and saves your
credentials to `~/.volcano/config.json` — one command signs you up and logs
you in.
This opens the browser signup page with your git email filled in. When you

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚪ P3: Quickstart doesn't tell readers to cd into the directory connect creates

The old step 3 ran volcano use, which set the active project for every directory. volcano connect --signup with no directory argument creates a new subdirectory such as ./fuji-amber-42 and only links the project there (see cli/connect.md, "Linked directories" and "Running from an agent"). The intro still says "This gets you an account and an active project", and step 3 sends readers straight to /cli to deploy a function. A reader who stays in the parent directory hits exit code 3, "No project is selected". The CLI does print Next: cd ./fuji-amber-42, so the impact is small. One sentence would cover it, such as "cd into the directory it prints before running other volcano commands."

Found by claude-opus-5-5

Comment thread content/get-started/quickstart.md Outdated
This prefills your email, opens the browser signup flow, and saves your
credentials to `~/.volcano/config.json` — one command signs you up and logs
you in.
This opens the browser signup page with your git email filled in. When you

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚪ P3: "with your git email filled in" is stated as if it always happens

According to cli/connect.md (the --signup flag row and "New accounts and the project limit"), --signup skips private relay addresses such as noreply.github.com, as well as local or test addresses. Without a usable address, connect stops before it signs in and asks you to rerun with --email. GitHub noreply addresses are a common global git email, so many new users following the quickstart will get that stop rather than a prefilled page. A short clause would set expectations, for example "(or pass --email you@​company.com if your git email is missing or private)".

Found by claude-opus-5-5

Comment thread content/cli/connect.md Outdated
npm install -g @volcano.dev/cli
volcano connect
volcano connect --signup # new to Volcano
volcano connect # you already have an account

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 P2: Copying the opening example runs both onboarding alternatives

Pasting this block outside a linked directory runs connect --signup and then plain connect. The first command creates a project in a child directory without changing the shell's directory, so the second creates another project or fails at the account's project limit. Put the alternatives in separate blocks or comment out the existing-account command so copying the example runs only one.

Found by gpt-6.1-sol

Copying the connect page's example ran both `connect --signup` and plain
`connect`. Give new and existing users separate instructions. In the
quickstart, say to cd into the directory connect prints, and what to do
when the git email is missing or private.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@connorckong
connorckong added this pull request to the merge queue Nov 19, 2026
Merged via the queue into main with commit 9ea817f Nov 19, 2026
19 checks passed
@connorckong
connorckong deleted the connorckong/setup-prompt-signup branch November 19, 2026 09:08
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.

1 participant