Skip to content

docs(web/guides): name the dead cfwheels-base-template slug and redirect to wheels-base-template#3253

Open
bpamiri wants to merge 1 commit into
developfrom
fix/docs-commandbox-legacy-slug
Open

docs(web/guides): name the dead cfwheels-base-template slug and redirect to wheels-base-template#3253
bpamiri wants to merge 1 commit into
developfrom
fix/docs-commandbox-legacy-slug

Conversation

@bpamiri

@bpamiri bpamiri commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Docs signpost for the dead cfwheels-base-template slug

Addresses the documentation sliver of #3182. The core of #3182 — capping the legacy cfwheels-base-template / cfwheels-cli ForgeBox slugs and the cfwheels.org apex DNS — requires credentialed ForgeBox + DNS actions only the maintainer can perform (see the deprecation runbook in #3182). This PR handles the one piece the guides own.

What changed

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

  • The 2.x/3.x → 4.x migration table previously claimed box install wheels-base-template + wheels-core was "Unchanged" — inaccurate for a genuine 2.x user, whose slug did change (cfwheels-base-templatewheels-base-template). The row now reads "Slug changed".
  • Adds a caution <Aside> naming the dead cfwheels--prefixed slugs and mapping them to the supported 4.x slugs (cfwheels-base-templatewheels-base-template, cfwheelswheels-core), so a migrating 2.x user with box install cfwheels-base-template in muscle memory gets a clear redirect instead of a broken skeleton.

Scope

…ect to wheels-base-template

The Installing with CommandBox page existed to give 2.x/3.x CommandBox
teams a clear Wheels 4 answer, but it never mentioned the slug a
migrating 2.x user actually has in muscle memory:
`box install cfwheels-base-template`. That pre-rebrand slug still
resolves on ForgeBox (76,754 installs, top 'cfwheels' search hit) but
errors on its missing `cfwheels` core dependency and leaves an
unrunnable skeleton.

Worse, the 2.x/3.x migration table claimed
`box install wheels-base-template` + `wheels-core` was 'Unchanged' —
inaccurate for a genuine 2.x user, whose slug DID change
(cfwheels-base-template -> wheels-base-template). The row now reads
'Slug changed' and a caution Aside maps the dead cfwheels- prefixed
slugs to the supported 4.x slugs (cfwheels-base-template ->
wheels-base-template, cfwheels -> wheels-core).

Refs #3198 (post-merge review finding)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Fable 5 <[email protected]>
Signed-off-by: Peter Amiri <[email protected]>
@github-actions github-actions Bot added the bug label Jun 24, 2026
@bpamiri bpamiri marked this pull request as ready for review June 24, 2026 03:16

@wheels-bot wheels-bot Bot left a comment

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.

Wheels Bot — Reviewer

TL;DR — This docs-only PR (+14/-1, one MDX file) corrects the 2.x→4.x CommandBox migration table in installing-with-commandbox.mdx: it rewrites the row that wrongly claimed the cfwheels-base-template slug was "Unchanged" to "Slug changed", and adds a caution <Aside> mapping the dead cfwheels--prefixed slugs to their supported 4.x replacements. The change is accurate, well-scoped, and the internal anchors resolve. Verdict: comment — one minor content nit, nothing blocking.

Docs

  • installing-with-commandbox.mdx:132 — the new in-page link resolves correctly: #supported-install-the-framework matches the ## Supported: install the framework heading at line 46 (Starlight GitHub-style slug). Verified.

  • installing-with-commandbox.mdx:127 (minor, non-blocking) — the section is titled "Coming from a 2.x / 3.x box workflow", but the rewritten row only addresses the 2.x slug (cfwheels-base-template → "Slug changed"). Because the rebrand landed at 3.0, a 3.x reader was already on wheels-base-template, so for them this command was genuinely unchanged — the old row carried that signal and the rewrite drops it. Consider keeping a short "unchanged for 3.x users" note, or splitting the row, so the 3.x half of the audience is still addressed. Marginal; the <Aside> and the body of the page already document wheels-base-template thoroughly, so this is not a correctness problem.

Conventions

  • Claim "The framework rebranded to Wheels at 3.0" matches CLAUDE.md ("The rebrand happened at v3.0").
  • <Aside type="caution" title=...> matches the component imported at line 9 and the three existing uses in-file (lines 29, 71, 113).

Commits

  • docs(web/guides): name the dead cfwheels-base-template slug and redirect to wheels-base-template — valid type (docs), valid optional scope (web/guides), header 96 chars (< 100), not ALL-CAPS, and the subject describes the why (correcting an inaccurate migration-table claim).

No changelog fragment is required: this is a guides-site docs edit, not a framework user-facing fix/feat. Scope (Refs #3182, does not close it) is stated honestly in the PR body.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant