Skip to content

Commit bb98ffe

Browse files
bpamiriclaude
andauthored
docs(web/guides): correct start-here guide drift from the 2026-06 behavioral audit (#3120)
* docs(web/guides): correct start-here guide drift from the 2026-06 behavioral audit Six audit findings across the non-tutorial start-here pages (audit group p2-1, claims index-01 / welcome-01 / whywheels-01 / installing-03 / rc-01 / engines-04): - index.mdx: add the missing Release Channels LinkCard to the section grid - welcome.mdx: include BoxLang in the supported-engine list (matches cfml-engines.mdx and the CI compat matrix) - why-wheels.mdx: the Rails Jobs row cited a nonexistent worker CLI (wheels jobs work); describe the real programmatic surface and cite ##3090 for the worker CLI - installing.mdx: drop the 3x stale 'Multiple version surfaces during 4.0-SNAPSHOT' asides (4.0 GA shipped 2026-06-09) - release-channels.mdx: the channel parenthetical comes from 'wheels version' (Wheels 4.0.3 (stable) + Java line), not 'wheels --version' (no channel info); fix the at-a-glance row and the how-to-tell sample, verified against the released 4.0.3 CLI - cfml-engines.mdx: 'generators are pure file-system operations' gains the 'wheels generate admin' exception (requires a running project-bound server; Module.cfc write-side guard) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Peter Amiri <peter@alurium.com> * docs(web/guides): scope the --version channel claim by install method The unqualified 'no channel parenthetical' note was wrong for two shipped install paths: the deb/rpm wrapper and the Homebrew bleeding-edge formula both short-circuit --version and print 'wheels <version> (<channel>)'. Reviewer-supplied wording; the installation.mdx cross-page sync rides with the cliref audit group. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Peter Amiri <peter@alurium.com> --------- Signed-off-by: Peter Amiri <peter@alurium.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 7fae2a3 commit bb98ffe

6 files changed

Lines changed: 13 additions & 20 deletions

File tree

web/sites/guides/src/content/docs/v4-0-0/start-here/cfml-engines.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Two routes, depending on what you already have installed.
6868
If you already have Adobe CF installed (e.g. the dev edition from [coldfusion.adobe.com](https://www.adobe.com/products/coldfusion-family.html)), point its web root at your Wheels app's `public/` directory and configure the datasource through the CF Administrator. The framework requires no engine-specific setup beyond having a registered datasource.
6969

7070
<Aside type="note">
71-
The `wheels start`, `wheels stop`, `wheels reload`, and `wheels test` commands all assume the Lucee Express bundled with the CLI. On Adobe CF you'll use `box server start/stop/restart` instead, and reload via `?reload=true&password=<your-password>` directly. Generators (`wheels generate ...`) are pure file-system operations and work the same regardless of engine.
71+
The `wheels start`, `wheels stop`, `wheels reload`, and `wheels test` commands all assume the Lucee Express bundled with the CLI. On Adobe CF you'll use `box server start/stop/restart` instead, and reload via `?reload=true&password=<your-password>` directly. Generators (`wheels generate ...`) are pure file-system operations and work the same regardless of engine — with one exception: `wheels generate admin` introspects your database schema through a running server bound to the project, and refuses to run without one.
7272
</Aside>
7373

7474
## Running Wheels on BoxLang
@@ -82,7 +82,7 @@ box server start cfengine=boxlang@latest port=8080
8282
```
8383

8484
<Aside type="note">
85-
The `wheels start`, `wheels stop`, `wheels reload`, and `wheels test` commands all assume the Lucee Express bundled with the CLI — they do not interact with BoxLang. BoxLang developers manage their server through CommandBox (`box server start/stop/restart`) and reload via `?reload=true&password=<your-password>` directly. Generators (`wheels generate ...`) are pure file-system operations and work the same regardless of engine.
85+
The `wheels start`, `wheels stop`, `wheels reload`, and `wheels test` commands all assume the Lucee Express bundled with the CLI — they do not interact with BoxLang. BoxLang developers manage their server through CommandBox (`box server start/stop/restart`) and reload via `?reload=true&password=<your-password>` directly. Generators (`wheels generate ...`) are pure file-system operations and work the same regardless of engine — with one exception: `wheels generate admin` introspects your database schema through a running server bound to the project, and refuses to run without one.
8686
</Aside>
8787

8888
Wheels' BoxLang compatibility is verified per release in the same CI matrix as Lucee and Adobe CF. Cross-engine gotchas worth knowing about live in [`.ai/wheels/cross-engine-compatibility.md`](https://github.com/wheels-dev/wheels/blob/develop/.ai/wheels/cross-engine-compatibility.md) — most are about minor differences in struct/array semantics under closures.

web/sites/guides/src/content/docs/v4-0-0/start-here/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The entry path for new Wheels developers. Follow it top to bottom.
1515
<LinkCard title="Why Wheels?" href="/v4-0-0/start-here/why-wheels/" />
1616
<LinkCard title="Installing Wheels" href="/v4-0-0/start-here/installing/" />
1717
<LinkCard title="Your First 15 Minutes" href="/v4-0-0/start-here/first-15-minutes/" />
18+
<LinkCard title="Release Channels" href="/v4-0-0/start-here/release-channels/" />
1819
<LinkCard title="Tutorial: Build a Blog" href="/v4-0-0/start-here/tutorial/" />
1920
<LinkCard title="CFML Engines" href="/v4-0-0/start-here/cfml-engines/" />
2021
</CardGrid>

web/sites/guides/src/content/docs/v4-0-0/start-here/installing.mdx

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,6 @@ The two are mutually exclusive — both expose the `wheels` binary. You install
105105

106106
You should see a `Wheels Version: <version>` line followed by ASCII art. A `Lucee Version: <version>` line may also appear once Lucee Express has been downloaded (typically on first `wheels start`). Any non-empty version output means the CLI is wired up correctly.
107107

108-
<Aside type="note" title="Multiple version surfaces during 4.0-SNAPSHOT">
109-
During the 4.0 pre-release, three places report a Wheels version: the package-manager formula (e.g. `brew info wheels`), `wheels --version` (CLI runtime), and the dev-mode debug bar shown on every rendered page (framework). They may currently disagree — the framework still reports `0.0.0-dev` even when the CLI reports a real version. This is tracked and will converge before 4.0 GA. If your CLI version output is non-empty and roughly matches the formula, your install is fine.
110-
</Aside>
111-
112108
</Steps>
113109

114110
</TabItem>
@@ -155,10 +151,6 @@ The legacy `wheels` package on chocolatey.org is the CommandBox-based v1.x relea
155151

156152
You should see a `Wheels Version: <version>` line followed by ASCII art. A `Lucee Version: <version>` line may also appear once Lucee Express has been downloaded (typically on first `wheels start`). Any non-empty version output means the CLI is wired up correctly.
157153

158-
<Aside type="note" title="Multiple version surfaces during 4.0-SNAPSHOT">
159-
During the 4.0 pre-release, three places report a Wheels version: the package-manager formula (e.g. `brew info wheels`), `wheels --version` (CLI runtime), and the dev-mode debug bar shown on every rendered page (framework). They may currently disagree — the framework still reports `0.0.0-dev` even when the CLI reports a real version. This is tracked and will converge before 4.0 GA. If your CLI version output is non-empty and roughly matches the formula, your install is fine.
160-
</Aside>
161-
162154
</Steps>
163155

164156
Pick LuCLI and Wheels Module versions that are known to be paired — see [CLI Installation → Manual JAR install](/v4-0-0/command-line-tools/installation/#manual-jar-install) for the canonical version-pairing source.
@@ -217,10 +209,6 @@ The apt and yum repos are GPG-signed with the Wheels Distribution key (fingerpri
217209

218210
You should see a `Wheels Version: <version>` line followed by ASCII art. A `Lucee Version: <version>` line may also appear once Lucee Express has been downloaded (typically on first `wheels start`). Any non-empty version output means the CLI is wired up correctly.
219211

220-
<Aside type="note" title="Multiple version surfaces during 4.0-SNAPSHOT">
221-
During the 4.0 pre-release, three places report a Wheels version: the package-manager formula (e.g. `brew info wheels`), `wheels --version` (CLI runtime), and the dev-mode debug bar shown on every rendered page (framework). They may currently disagree — the framework still reports `0.0.0-dev` even when the CLI reports a real version. This is tracked and will converge before 4.0 GA. If your CLI version output is non-empty and roughly matches the formula, your install is fine.
222-
</Aside>
223-
224212
</Steps>
225213

226214
</TabItem>

web/sites/guides/src/content/docs/v4-0-0/start-here/release-channels.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,30 @@ Wheels ships on two parallel channels. Pick the one that matches how much churn
2020
| Source repo | [`wheels-dev/wheels`](https://github.com/wheels-dev/wheels) | [`wheels-dev/wheels-snapshots`](https://github.com/wheels-dev/wheels-snapshots) |
2121
| Best for | Production apps, teams that want predictability | Framework contributors, early adopters, validating fixes before they GA |
2222
| Version string shape | `4.0.0`, `4.1.0` | `4.0.1-snapshot.1700` |
23-
| `wheels --version` reports | `(stable)` | `(bleeding-edge)` |
23+
| `wheels version` reports | `(stable)` | `(bleeding-edge)` |
2424

2525
## How to tell which channel you're on
2626

2727
```bash title="your shell"
28-
wheels --version
28+
wheels version
2929
```
3030

3131
The output's parenthetical tells you the channel:
3232

3333
```
34-
Wheels Version: 4.0.0 (stable)
34+
Wheels 4.0.3 (stable)
35+
Java 21.0.11
3536
```
3637

3738
…or:
3839

3940
```
40-
Wheels Version: 4.0.0-snapshot.1787 (bleeding-edge)
41+
Wheels 4.0.0-snapshot.1787 (bleeding-edge)
42+
Java 21.0.11
4143
```
4244

45+
Note the command is `wheels version` (no dashes). The flag form `wheels --version` varies by install method — Homebrew stable and manual JAR installs print a `Wheels Version: <version>` banner plus ASCII art with no channel, while the apt/yum and Homebrew bleeding-edge package wrappers print a one-line `wheels <version> (<channel>)`. `wheels version` is the form that reports the channel reliably everywhere.
46+
4347
If you see `(development)` instead, you're running from a dev checkout (cloned source repo) rather than an installed package — which is its own thing and not covered here.
4448

4549
## Installing each channel

web/sites/guides/src/content/docs/v4-0-0/start-here/welcome.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A two-minute orientation before you write any code.
2222

2323
## What Wheels is
2424

25-
Wheels is a full-stack web framework for CFML. It runs on Lucee (open source) and Adobe ColdFusion (commercial). It gives you an ActiveRecord-style ORM, a request pipeline with middleware, a convention-driven file layout, and a scaffold generator that writes working code from a model name. You spend your time on the interesting parts of your app.
25+
Wheels is a full-stack web framework for CFML. It runs on Lucee (open source), Adobe ColdFusion (commercial), and BoxLang. It gives you an ActiveRecord-style ORM, a request pipeline with middleware, a convention-driven file layout, and a scaffold generator that writes working code from a model name. You spend your time on the interesting parts of your app.
2626

2727
The `wheels` CLI is the only tool you need. It creates apps, runs migrations, generates scaffolds, starts the dev server, runs tests, and ships your code. Under the hood it wraps a Java-based CFML runtime; you rarely think about that.
2828

web/sites/guides/src/content/docs/v4-0-0/start-here/why-wheels.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Closest conceptual neighbor. Both descended from the same Rails-era design.
4343
| View layer | ERB / Haml / etc. | `.cfm` templates (inline expressions via `#...#`) |
4444
| Hotwire | Bundled (Turbo Drive / Frames / Streams) | Via `wheels-hotwire` package (opt-in activation) |
4545
| Testing | Minitest / RSpec | WheelsTest (BDD, `describe`/`it`) |
46-
| Jobs | Active Job + Sidekiq/etc. | Built-in job queue (`wheels jobs work`) |
46+
| Jobs | Active Job + Sidekiq/etc. | Built-in DB-backed job queue (`wheels.Job` / `processQueue()`); worker CLI tracked in [#3090](https://github.com/wheels-dev/wheels/issues/3090) |
4747

4848
If you know Rails, the tutorial will feel familiar in pacing and idioms. The differences that bite most often:
4949

0 commit comments

Comments
 (0)