Update docs #830
Merged
Update docs #830
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WIP Doc
New deprecation in React 16, hydrate should be used client side. https://reactjs.org/blog/2017/09/26/react-v16.0.html#new-deprecations
Also use doctoc for table of contents in readme Readme updated to reference other docs and looks cleaner Update Docs
|
👍 Looks like a nice reorg! I appreciate putting the development instructions into CONTRIBUTING, that makes the readme a bit less intimidating 😆 Agreed about the issue template, I added it a while ago but I bet if it were revised, we could get more value out of it. |
Borrow content from Rails' Issue template. It emphasizes reproduction.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@rmosolgo In this PR I change a lot of the Readme to try make it easier to follow the main sections and display the main benefits at the top of the README.
Also added Contributing and Code of Conduct as they are standard and can encourage best practice.
Small wording tweak in the Issues Template, it would be good to review it as almost all issues that come in are of the form "- [x] Discussion, something is wrong" and reproducing is hard.
I want to continue to add to the Wiki more How to's as I've been able to use the react-rails-example-app to close a good dozen issues where folk have just needed guidance. The issues I marked as Discussion are good candidates to close when we have a matching Wiki entry for them.
Also mentioned @renchap 's Webpacker-react in the related projects as it looks promising.
Thoughts?
Closes #825