Skip to content

Commit 1a63f50

Browse files
authored
Update and slightly move the upgrades page (#3930)
1 parent 41e661f commit 1a63f50

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ title: Strawberry docs
1414
- [Subscriptions](./general/subscriptions.md)
1515
- [Multipart Subscriptions](./general/multipart-subscriptions.md)
1616
- [Errors](./errors)
17-
- [Breaking changes](./breaking-changes.md)
1817
- [Upgrading Strawberry](./general/upgrades.md)
18+
- [Breaking changes](./breaking-changes.md)
1919
- [FAQ](./faq.md)
2020

2121
## Types

docs/general/upgrades.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ need to make updates to the public API. While we try to deprecate APIs before
1111
removing them, we also want to make it as easy as possible to upgrade to the
1212
latest version of Strawberry.
1313

14-
For this reason we provide a CLI command that can automatically upgrade your
15-
codebase to use the updated APIs.
14+
For this reason, we provide a CLI command to run Codemods that can automatically
15+
upgrade your codebase to use the updated APIs.
1616

17-
At the moment we only support updating unions to use the new syntax with
18-
annotated, but in future we plan to add more commands to help with upgrading.
17+
Keep an eye on our release notes and the
18+
[breaking changes](../breaking-changes.md) page to see if a new Codemod is
19+
available, or if manual changes are required.
1920

20-
Here's how you can use the command to upgrade your codebase:
21+
Here's an example of how to upgrade your codebase by running a Codemod using the
22+
Strawberry CLI's `upgrade` command:
2123

2224
```shell
2325
strawberry upgrade annotated-union .

0 commit comments

Comments
 (0)