Skip to content

Improve docs installation steps #487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 26, 2017
Merged

Improve docs installation steps #487

merged 4 commits into from
Feb 26, 2017

Conversation

wkwiatek
Copy link
Collaborator

No description provided.

README.md Outdated

If you'd rather stay with **Browserify**, check out **[LiveReactload](https://github.com/milankinen/livereactload)** by Matti Lankinen.

## Known limitations

- React Router v3 is not fully supported. If you want to get most of React Hot Loader, consider switching to [React Router v4](https://reacttraining.com/react-router/). If you want to understand the reasoning, it's good to start in [React Router v4 FAQ](https://github.com/ReactTraining/react-router/blob/v4/README.md#v4-faq)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we should push people to RR4 until it's been fully released. Also, there are plenty of workarounds for RR3 that we can supply.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still wondering what's the best option here... RHL and RR v3 are not the best pair and because of that RHL feels like 'works sometimes' and many of the issues are strictly related to RR. I just think we should communicate this somehow.

On the other hand v4 works much better (and seems to be pretty solid) but it's still in beta. What about just adding some warning that v4 is still not a production version?

docs/README.md Outdated
@@ -28,7 +28,7 @@
}
```

- 'react-hot-loader/patch' should be placed at the top of the `entry` section in your Webpack config. An error will occur if any code runs before `react-hot-loader/patch` has, so put it in the first position.
- 'react-hot-loader/patch' should be placed at the top of the `entry` section in your Webpack config. An error will occur if any app code runs before `react-hot-loader/patch` has, so put it in the first position (note: if you use any polyfills then it should go right after them).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe give a code example with babel-polyfill specifically?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely, will do!

@calesce
Copy link
Collaborator

calesce commented Feb 26, 2017

Looks great!

@calesce calesce merged commit e78c134 into next Feb 26, 2017
@calesce calesce deleted the next-docs branch February 26, 2017 19:09
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.

2 participants