Skip to content

docs: align chapter 8 with wheels-basecoat 3.0.0 INSTALL.md (F16)#2409

Merged
bpamiri merged 1 commit intodevelopfrom
peter/f16-chapter-8-basecoat-3.0-install
May 2, 2026
Merged

docs: align chapter 8 with wheels-basecoat 3.0.0 INSTALL.md (F16)#2409
bpamiri merged 1 commit intodevelopfrom
peter/f16-chapter-8-basecoat-3.0-install

Conversation

@bpamiri
Copy link
Copy Markdown
Collaborator

@bpamiri bpamiri commented May 2, 2026

Summary

Chapter 8 was written for wheels-basecoat@1.0.2 (CSS-only, user downloads basecoat.min.css from jsdelivr themselves). The live registry now serves 3.0.0, which ships its full CSS+JS bundle at vendor/wheels-basecoat/assets/basecoat/. A fresh-VM tutorial follower currently gets 3.0.0 installed and is then told to do a redundant CDN download — works, but produces a setup that doesn't match the package's own INSTALL.md.

Aligned the chapter to the INSTALL.md pattern:

  • ${\textsf{Serve the basecoat CSS asset}}$${\textsf{Publish the basecoat assets}}$
  • curl/jsdelivr step → cp -r vendor/wheels-basecoat/assets/basecoat public/assets/basecoat
  • Layout helper: basecoatIncludes(basecoatCSSPath="...")basecoatIncludes() (reads bundled defaults)
  • Asset URL: /assets/basecoat.min.css/assets/basecoat/basecoat.min.css (also reflected in the troubleshooting section)
  • Sample install output and example package.json snippet are now version-agnostic so future basecoat releases don't drift the chapter again
  • Added a callout pointing readers at vendor/wheels-basecoat/INSTALL.md for whichever version they have — post-3.0 majors may diverge

The CLI activation message was already corrected in #2399; the chapter now matches.

Source

F16 from the 2026-05-01 fresh-VM tutorial run.

Test plan

  • Build the docs site and confirm chapter 8 renders cleanly
  • Walk a fresh tutorial app through chapter 8 against wheels-basecoat@3.0.0: package installs, cp -r step succeeds, basecoatIncludes() resolves, post show view renders with basecoat classes
  • Visual baseline (packages-index.png) — should be unaffected since chapter changes don't reach the package detail page

🤖 Generated with Claude Code

The chapter was written against wheels-basecoat 1.0.2 — a CSS-only
distribution where users had to download basecoat.min.css from jsdelivr
themselves. The live registry now serves 3.0.0, which ships its full
CSS+JS bundle inside the package at vendor/wheels-basecoat/assets/. A
fresh-VM tutorial follower currently gets 3.0.0 installed and is then
told (by the chapter) to download a separate copy from a CDN — works,
but produces a setup that doesn't match the package's own INSTALL.md.

Aligned the chapter to the INSTALL.md pattern (which the package ships
inside vendor/ for users to read):

  - "Serve the basecoat CSS asset" → "Publish the basecoat assets"
  - curl/jsdelivr step → `cp -r vendor/wheels-basecoat/assets/basecoat
    public/assets/basecoat`
  - Layout helper goes from `basecoatIncludes(basecoatCSSPath="...")`
    (explicit override) to `basecoatIncludes()` (reads bundled defaults)
  - Asset URL changes from `/assets/basecoat.min.css` to
    `/assets/basecoat/basecoat.min.css` — reflected in troubleshooting
  - Sample install output and example package.json snippet are now
    version-agnostic so future basecoat releases don't drift the chapter
  - Added a callout pointing readers at vendor/wheels-basecoat/INSTALL.md
    for whichever version they have, since post-3.0 majors may diverge

The CLI activation message (`Run wheels stop && wheels start ...`) was
already corrected in #2399 — the chapter now matches.

F16 from the 2026-05-01 fresh-VM tutorial run.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@bpamiri bpamiri merged commit 115ded1 into develop May 2, 2026
10 checks passed
@bpamiri bpamiri deleted the peter/f16-chapter-8-basecoat-3.0-install branch May 2, 2026 03:57
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