Skip to content

Conversation

@tomkp
Copy link
Owner

@tomkp tomkp commented Jan 6, 2026

Summary

Updates the migration guide to include a dedicated section for v2.x users, since v2.x had a different API than v0.1.x.

Key changes:

  • Add "Migrating from v2.x" section with specific prop mappings (v2 already used <Pane> components with initialSize)
  • Keep "Migrating from v0.1.x" section for users on the older API
  • Document key differences: initialSizedefaultSize, splitdirection swap, callback signature changes
  • Update README.md and CHANGELOG.md references

Closes #863

Test plan

  • Review MIGRATION.md renders correctly on GitHub
  • Verify all code examples are properly formatted
  • Check that the migration guide is linked from README.md and CHANGELOG.md

Update the migration guide to include a dedicated section for v2.x users.
v2.x had a different API than v0.1.x (it already used Pane components with
initialSize prop), so each version needs its own migration instructions.

- Add "Migrating from v2.x" section with specific prop mappings
- Keep "Migrating from v0.1.x" section for older users
- Document key differences: initialSize→defaultSize, split→direction swap
- Update README.md and CHANGELOG.md references

Closes #863
@tomkp tomkp force-pushed the docs/migration-guide-v2 branch from 6eda032 to 10ef9b7 Compare January 6, 2026 07:10
@tomkp tomkp merged commit c1626a2 into master Jan 6, 2026
1 check passed
@tomkp tomkp deleted the docs/migration-guide-v2 branch January 6, 2026 07:15
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.

Migration guide from v2 to v3

2 participants