ctrlplusb / react-universally

A starter kit for universal react applications.
MIT License
1.7k stars 244 forks source link

Docs! Docs! Docs! #275

Open ctrlplusb opened 7 years ago

ctrlplusb commented 7 years ago

Instead of relying too much on code comments I think we should expand the docs somewhat.

oyeanuj commented 7 years ago

As someone trying to pick a new starter kit, this would be a +100 request! Especially, guides or recipes around how to add/remove certain choices of libraries!

Thank you for creating this project! :)

cloud-walker commented 7 years ago

I'm using your boilerplate in production till this summer, and I see is pretty changed now.

I think the development server needs to be covered more than other parts.

Its a pretty delicate part, that I still need to understand fully...

For example, I remember that the client must be compiled before the server for some reason (I guess to retrieve the compiled assets..)

ctrlplusb commented 7 years ago

@oyeanuj - sure thing! I have tried to document the code, but if there are any specific macro concepts that would best covered by docs please let me know.

@cloud-walker - thanks for the constructive feedback. I'll def take this on board.

rohmanhm commented 7 years ago

How about Example! Example! Example! I moved from NextJS to react-universally and there's no example project yet.

oyeanuj commented 7 years ago

@ctrlplusb do you think about having a short doc on comparison with other similar options, like NextJS, etc? As a user trying to opt in, some of the points are hard to know upfront and something like that would be priceless.