Repository navigation
docs(get-started): sign new users up with connect --signup - #236
Conversation
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>
AI review: no P0-P2 findingsDocs-only change. New users are now sent to 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.
Human review: not needed |
| 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 |
There was a problem hiding this comment.
⚪ 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
| 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 |
There was a problem hiding this comment.
⚪ 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
| npm install -g @volcano.dev/cli | ||
| volcano connect | ||
| volcano connect --signup # new to Volcano | ||
| volcano connect # you already have an account |
There was a problem hiding this comment.
🟡 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>
Summary
Plain
volcano connectopens 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 plainvolcano connect.cli/connect.md: the opening example shows--signupfor new users and plainconnectfor 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:
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.connect): 0/2. Both runs stopped at the sign-in page.Validation
pnpm lint:docs content/get-startedandcontent/cli: OKnode scripts/check-links.mjs: OKpnpm build: OK🤖 Generated with Claude Code