From fe96b32a4def9d6742e66511ced192c520d16cf3 Mon Sep 17 00:00:00 2001 From: Connor Church <59625834+connorckong@users.noreply.github.com> Date: Thu, 19 Nov 2026 00:27:24 -0800 Subject: [PATCH 1/2] docs(get-started): sign new users up with connect --signup 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 --- content/cli/connect.md | 13 ++++++++++--- content/get-started/quickstart.md | 20 ++++++++++---------- 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/content/cli/connect.md b/content/cli/connect.md index 8dd7d12..3dca0da 100644 --- a/content/cli/connect.md +++ b/content/cli/connect.md @@ -12,10 +12,15 @@ for other ways to install. ```bash npm install -g @volcano.dev/cli -volcano connect +volcano connect --signup # new to Volcano +volcano connect # you already have an account ``` -Run it yourself, or paste both lines into a coding agent. +Run it yourself, or paste this prompt into a coding agent: + +```text +Run `npm i -g @volcano.dev/cli && volcano connect --signup` and keep it running while I sign up. +``` It runs these steps. A rerun inside the linked directory, or with the same directory argument, keeps the project and updates the files in place. A rerun @@ -29,7 +34,9 @@ characters in single quotes, so you can paste them as they are. 1. **Signs in.** It signs in with `--device-code` when given. Otherwise it reuses a login that still works, or runs browser login. Browser login prints a code and a link. Open the link and approve, and the - command continues. See + command continues. That page signs in an existing account with GitHub, + Google, or email and password. It can't create an account by email, so + run `volcano connect --signup` if you're new. See [Device codes from the dashboard](#device-codes-from-the-dashboard). 2. **Creates a project and its directory.** Unless `--project` names one, or the directory is already linked, it creates a new project. diff --git a/content/get-started/quickstart.md b/content/get-started/quickstart.md index 931d0f5..d7ca020 100644 --- a/content/get-started/quickstart.md +++ b/content/get-started/quickstart.md @@ -15,24 +15,24 @@ npm install -g @volcano.dev/cli See [install](./install.md) for other methods. -## 2. Sign up +## 2. Sign up and create a project ```bash -volcano signup +volcano connect --signup ``` -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 +finish, the CLI is signed in, creates a cloud project, and sets up a directory +linked to it. Already have an account? Use the log-in link on the signup page, +or run `volcano connect` instead. See [connect](/cli/connect) for the details. -## 3. Create and select a project +To have a coding agent do it, paste this prompt: -```bash -volcano projects create my-first-project -volcano use my-first-project +```text +Run `npm i -g @volcano.dev/cli && volcano connect --signup` and keep it running while I sign up. ``` -## 4. Build +## 3. Build Pick your path: From 98ae4f325a99caadf70c53068721a1388ff48a32 Mon Sep 17 00:00:00 2001 From: Connor Church <59625834+connorckong@users.noreply.github.com> Date: Thu, 19 Nov 2026 00:51:05 -0800 Subject: [PATCH 2/2] docs(get-started): split the connect example and cover cd and --email 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 --- content/cli/connect.md | 7 +++++-- content/get-started/quickstart.md | 17 +++++++++++------ 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/content/cli/connect.md b/content/cli/connect.md index 3dca0da..18ac78d 100644 --- a/content/cli/connect.md +++ b/content/cli/connect.md @@ -10,12 +10,15 @@ linked to it, in one command. Install the CLI first, because you keep using it to build and deploy after `connect`. See [installation.md](installation.md) for other ways to install. +New to Volcano: + ```bash npm install -g @volcano.dev/cli -volcano connect --signup # new to Volcano -volcano connect # you already have an account +volcano connect --signup ``` +Already have an account? Run `volcano connect` instead. + Run it yourself, or paste this prompt into a coding agent: ```text diff --git a/content/get-started/quickstart.md b/content/get-started/quickstart.md index d7ca020..0d1819e 100644 --- a/content/get-started/quickstart.md +++ b/content/get-started/quickstart.md @@ -4,8 +4,8 @@ description: Install the CLI, sign up, create a project, and start building. order: 3 --- -This gets you an account and an active project. From there, follow the -surface-specific quickstart for what you are building. +This gets you an account and a project linked to a local directory. From +there, follow the surface-specific quickstart for what you are building. ## 1. Install the CLI @@ -21,10 +21,15 @@ See [install](./install.md) for other methods. volcano connect --signup ``` -This opens the browser signup page with your git email filled in. When you -finish, the CLI is signed in, creates a cloud project, and sets up a directory -linked to it. Already have an account? Use the log-in link on the signup page, -or run `volcano connect` instead. See [connect](/cli/connect) for the details. +This opens the browser signup page with your global git email filled in. +If that email is missing or private (such as a GitHub `noreply` address), +`connect` stops and asks for one: run it again with +`--email you@company.com`. When you finish signing up, the CLI is signed in, +creates a cloud project, and sets up a directory linked to it. `cd` into the +directory it prints before you run other `volcano` commands. + +Already have an account? Use the log-in link on the signup page, or run +`volcano connect` instead. See [connect](/cli/connect) for the details. To have a coding agent do it, paste this prompt: