docs(migrating-to-v2): fix typos #7892
Conversation
| @@ -407,7 +407,7 @@ Now, to add state to a link, pass it via a `state` prop. | |||
| ```jsx | |||
| const NewsFeed = () => ( | |||
| <div> | |||
| <Link to="photos/123" state={{ fromNewsFeed: true }} /> | |||
| <Link to="photos/123" state={{ fromFeed: true }} /> | |||
There was a problem hiding this comment.
The example was mixing fromNewsFeed and fromFeed, but this change makes it consistent.
docs/docs/migrating-from-v1-to-v2.md
Outdated
| @@ -843,7 +843,7 @@ In most cases you won't have to do anything to be v2 compatible, however there a | |||
|
|
|||
| ```json | |||
| "peerDependencies": { | |||
| "gatsby": ">=1" | |||
| "gatsby": ">=2" | |||
There was a problem hiding this comment.
I believe this should read 2 instead of 1 if I'm reading this section correctly, which is explaining how plugin authors can update for v2 support.
There was a problem hiding this comment.
If the plugin works for Gatsby v1 and v2 then >=1 is fine. A lot of plugins specify 1 as the supported version.
Maybe this docblock could be changed from json to diff and updated to show the change?
- "gatsby": "1"
+ "gatsby": ">=1"
There was a problem hiding this comment.
Thanks @macklinu 👍
I've requested one small change, otherwise all good!
docs/docs/migrating-from-v1-to-v2.md
Outdated
| @@ -843,7 +843,7 @@ In most cases you won't have to do anything to be v2 compatible, however there a | |||
|
|
|||
| ```json | |||
| "peerDependencies": { | |||
| "gatsby": ">=1" | |||
| "gatsby": ">=2" | |||
There was a problem hiding this comment.
If the plugin works for Gatsby v1 and v2 then >=1 is fine. A lot of plugins specify 1 as the supported version.
Maybe this docblock could be changed from json to diff and updated to show the change?
- "gatsby": "1"
+ "gatsby": ">=1"
|
@m-allanson thanks for the feedback! I've addressed your comment and pushed up. |
macklinu
force-pushed
the
macklinu/v1-to-v2-migration-docs
branch
from
63e6612 to
6d35e1e
Compare
|
@m-allanson I rebased the latest master into my branch and pushed up and didn't realize it would dismiss your review, my bad 😅 |
|
The dismissed reviews are a bit unexpected, I've been caught by that too! Generally I wouldn't worry about rebasing for pull requests unless something is broken. As the rebase changes the commit times it can make it harder to see what's changed between PR reviews. All good on this one though, thanks for handling these updates :) |
This PR cleans up a few typos / examples in the migrating from v1 to v2 guide.