Migration Guides¶
Each guide covers the breaking changes introduced in a specific release and provides before/after code examples with a clear migration path.
Available guides¶
| From | To | Guide |
|---|---|---|
| v0.4 | v0.5 | Command composition redesign |
| v0.5 | v0.6 | Web-service components and shared TLS |
| v0.x | v1.0 | Migrating to v1.0 |
Writing a new guide¶
Use the _template.md file in this directory as a starting point:
- Copy it to
docs/migration/vX.Y-to-vX.Z.md. - Replace all placeholder text.
- Group changes by package.
- Include before/after code blocks and a prose migration path for each change.
- Remove the template warning admonition at the top.