docs(v3): add the v2 vs v3 comparison page to the migrate command - #5817
docs(v3): add the v2 vs v3 comparison page to the migrate command#5817taliesin-ai wants to merge 1 commit into
Conversation
The comparison page was written on the other `wails3 migrate` branch (#5755). It is the piece of that work worth keeping: a side-by-side reference of how v2 concepts map onto v3, which is what someone reaches for while migrating rather than reading the full guide top to bottom. It documents `wails3 migrate`, so it belongs with the command rather than ahead of it. Also: - Registers the page in the docs sidebar under Migration. - Adds the UNRELEASED_CHANGELOG entry this branch was missing. - Rewords the one FAQ line that described v3 as "in alpha/beta" to talk about pre-1.0 API stability instead. Release-status wording belongs in release announcements, not scattered through the reference docs where it goes stale. Verified: v3 builds; `go test ./internal/migrate/... ./internal/commands/` passes; the docs site builds (1721 pages, all locales). Claude-Session: https://claude.ai/code/session_01FigQqUQbNu9ngE4a2CSNm8
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (1)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
Documentation
leaanthony
left a comment
leaanthony
left a comment
There was a problem hiding this comment.
Right call to stack this rather than push into the worktree branch, and right call to keep the comparison page with the command rather than landing it on master ahead of wails3 migrate existing. The alpha/beta reword is worth having independently: release-status wording in reference docs is stale the day the status changes.
Not merging this into feat/wails3-migrate-command myself since that branch is checked out in an active worktree — merge it when convenient.
2 participants
Stacked on #5758 (base is
feat/wails3-migrate-command, not master), so it can be merged into that branch whenever convenient. I did not push directly tofeat/wails3-migrate-commandbecause it is checked out in an active local worktree.Why
There are two open
wails3 migratedrafts: #5758 (this base) and #5755. #5758 is the better implementation — the migration logic lives in its owninternal/migratepackage rather than ininternal/commands. But #5755 has one thing #5758 does not:docs/src/content/docs/migration/comparison.mdx, a side-by-side v2→v3 reference. That page is a stated beta requirement, and it is what someone actually reaches for mid-migration instead of reading a 750-line guide top to bottom.This ports that page across, so #5755 can be closed without losing it.
Changes
migration/comparison.mdxfrom feat(v3/cli): addwails3 migrateto assist v2 project migration #5755, and its sidebar registration.UNRELEASED_CHANGELOG.mdentry this branch was missing (the repo's convention is one entry per user-visible change; the automation uses yours if present).Verification
go build ./...in v3: clean.go test ./internal/migrate/... ./internal/commands/: pass.Note on #5755
Once this lands, #5755 is fully superseded: its command implementation is the weaker of the two and its only unique asset is now here. Worth closing it with a pointer to #5758 so contributors are not looking at two competing drafts.