Docs: Add hint to @comet/upgrade

[dkarnutsch]

• Add changeset (if necessary)

[nsams]

I would add the command in the migration guide everyone has to execute when upgrading. This is not optional.

And I would also remove all references in the migration guide to stuff that is done automatically with it. (We also have a changelog that should mention those renames)

the shorter the better

[johnnyomair]

And I would also remove all references in the migration guide to stuff that is done automatically with it. (We also have a changelog that should mention those renames)

Or we could do it similarly to how MUI does it:

https://mui.com/material-ui/migration/v5-component-changes/

[dkarnutsch]

@nsams like that?

[nsams]

@nsams like that?

yes, but I would even see it as part of every single migration guide

[nsams]

the migration guide should be like a tutorial

[thomasdax98]

yes, but I would even see it as part of every single migration guide
the migration guide should be like a tutorial

Yes, but IMO that doesn't mean we can't have some general information about the upgrade process in other parts of the docs. Also we don't have a direct reference to the comet-upgrade repo in the migration guide

[dkarnutsch]

Yes, but IMO that doesn't mean we can't have some general information about the upgrade process in other parts of the docs. Also we don't have a direct reference to the comet-upgrade repo in the migration guide

That was my intention. So I think this PR is alright as it is as it addresses a different part.