Skip to content

docs: add Wheels 4.0 upgrade guide#2130

Merged
bpamiri merged 3 commits intodevelopfrom
peter/upgrade-guide-4.0
Apr 16, 2026
Merged

docs: add Wheels 4.0 upgrade guide#2130
bpamiri merged 3 commits intodevelopfrom
peter/upgrade-guide-4.0

Conversation

@bpamiri
Copy link
Copy Markdown
Collaborator

@bpamiri bpamiri commented Apr 16, 2026

Summary

New standalone upgrade guide at docs/src/introduction/upgrading-to-4.0.md covering all 10 Breaking changes in 4.0 plus migration paths. Companion to #2123 (audit), #2124 (CHANGELOG), #2125 (comparison).

Spec: docs/superpowers/specs/2026-04-16-wheels-4.0-upgrade-guide-design.md
Plan: docs/superpowers/plans/2026-04-16-wheels-4.0-upgrade-guide.md

Structure (417 lines)

  • Before you start — backup, test environment, CHANGELOG
  • 5-minute upgrade checklist — scannable table of 10 Breaking items with one-liner fixes
  • Breaking changes — detailed — 10 items, each with consistent 4-part format (what changed / how to detect / how to fix / opt-out)
  • Legacy Compatibility Adapter — soft landing (feat: (W-003) Legacy compatibility adapter for 3.x to 4.0 migration #2015)
  • Recommended (not required) migrations — 10 items
  • Still stuck? — links to audit, comparison, adapter README, discussions

Plus a one-line {% hint style="info" %} callout at the top of the existing upgrading.md linking to the new guide.

Breaking items covered

# Item PR
1 CORS default: wildcard → deny-all #2039
2 allowEnvironmentSwitchViaUrl default false in prod #2076, #2082
3 HSTS default-on in prod #2081
4 CSRF cookie SameSite=Lax #2035
5 RateLimiter trustProxy default flipped #2024
6 RateLimiter proxy strategy default #2088
7 wheels snippetswheels code #1852
8 wheels.Testwheels.WheelsTest #1889
9 tests/specs/functions/functional/ #1872
10 application.wireboxapplication.wheelsdi #1888

Test plan

  • Every Breaking item from the CHANGELOG covered in detail (10/10)
  • Each item uses the consistent 4-part structure
  • Link integrity audit passed — all 6 relative links resolve
  • 14 PR numbers cited, all merged PRs
  • Callout link inserted at top of existing upgrading.md (above "General Upgrade Process")
  • GitBook preview renders correctly (CI will confirm)
  • Commitlint passes (CI will confirm)

Scope notes

This PR deliberately does not:

🤖 Generated with Claude Code

bpamiri and others added 2 commits April 16, 2026 14:21
Design doc for a new standalone upgrade guide at
docs/src/introduction/upgrading-to-4.0.md. Scope:

- Breaking + migration path (~350 lines)
- 10 Breaking items covered with consistent 4-part format:
  what changed / how to detect / how to fix / opt-out
- Legacy Compatibility Adapter documented as soft-landing option
- Recommended (not required) migrations section
- Single callout link added to existing upgrading.md

Spec companion to the feature audit (#2123), 3.0 → 4.0 comparison
(#2125), and CHANGELOG catch-up (#2124), which together form the
4.0 release-documentation stack.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
12-task plan covering:
  - File scaffold (front-matter + H1)
  - Before-you-start + 5-minute checklist
  - 10 Breaking items (3 tasks grouped by theme)
  - Legacy Compatibility Adapter section
  - Recommended migrations section
  - Still-stuck section
  - Callout link added to upgrading.md
  - Link integrity audit
  - Commit + push + PR

Each task includes the actual prose/code to write, with
verification via grep / wc / link-integrity script. No
placeholders; plan is executable end-to-end.

Companion to:
  docs/superpowers/specs/2026-04-16-wheels-4.0-upgrade-guide-design.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added the docs label Apr 16, 2026
@bpamiri bpamiri force-pushed the peter/upgrade-guide-4.0 branch from e8cd1db to 2cd53cb Compare April 16, 2026 23:10
New standalone upgrade guide at docs/src/introduction/upgrading-to-4.0.md
covering the 10 Breaking changes in 4.0 plus migration paths:

  - Before you start (backup, test environment, CHANGELOG)
  - 5-minute upgrade checklist (scannable table)
  - Breaking changes — detailed:
    * 6 security-hardening default flips (CORS, env-switch, HSTS,
      CSRF SameSite, RateLimiter trustProxy, RateLimiter proxy
      strategy)
    * 1 CLI rename (wheels snippets → wheels code)
    * 3 namespace / directory renames (wheels.Test → WheelsTest,
      tests/specs/functions/ → functional/, application.wirebox →
      application.wheelsdi)
  - Legacy Compatibility Adapter (#2015) — soft landing
  - Recommended (not required) migrations — 10 items
  - Still stuck? — links to audit, comparison, adapter, discussions

Each Breaking item uses a consistent 4-part format:
  What changed / How to detect / How to fix / Opt-out

Plus a one-line callout added to the top of the existing
docs/src/introduction/upgrading.md linking to the new guide.

Companion to:
  #2123 — 4.0 feature audit
  #2124 — CHANGELOG Unreleased expansion
  #2125 — 3.0 → 4.0 comparison doc

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@bpamiri bpamiri force-pushed the peter/upgrade-guide-4.0 branch from 2cd53cb to eab6da1 Compare April 16, 2026 23:16
@bpamiri bpamiri mentioned this pull request Apr 16, 2026
13 tasks
@bpamiri bpamiri merged commit 0cbadb8 into develop Apr 16, 2026
5 checks passed
@bpamiri bpamiri deleted the peter/upgrade-guide-4.0 branch April 16, 2026 23:25
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