Replace Starter Kit with doc link #8682
Conversation
gaearon
commented
Jan 4, 2017
gaearon
commented
- Fixes README to point to "Intro to JSX" rather than "JSX in Depth"
- Remove "A simple transform is included" since it's not included
- Replaces Installation paragraph with a starter kit to point to Installation sections in docs
- Removes the starter kit page
- Removes the starter kit build step
gaearon
requested review from
sophiebits,
acdlite and
aweary
and removed request for
sophiebits
|
I'm removing the starter kit because it is essentially a lie—it doesn't actually help you get started much, lacks production configuration, and examples show you 5 different ways to compile JSX without teaching React. They are not useful or a good starting point. |
| ``` | ||
| * [Trying Out React](https://facebook.github.io/react/docs/installation.html#trying-out-react) | ||
| * [Creating a Single Page Application](https://facebook.github.io/react/docs/installation.html#creating-a-single-page-application) | ||
| * [Adding React to an Existing Application](https://facebook.github.io/react/docs/installation.html#adding-react-to-an-existing-application) |
There was a problem hiding this comment.
These all 3 point to essentially the same place. Is there value in having them as separate links?
There was a problem hiding this comment.
I like that it lets readers jump directly into the appropriate section based on what they want to do, so they don't have to read the (albeit short) sections that are irrelevant to them.
There was a problem hiding this comment.
Fair enough.
I think readers might have an expectation of more substantial/lengthy content in the first 2 sections since they're separate links. But it's definitely just a nit; I was just thinking out loud. 😄
There was a problem hiding this comment.
I wanted to highlight that React can be used in all these scenarios right in README.
| @@ -27,32 +27,19 @@ ReactDOM.render( | |||
|
|
|||
| This example will render "Hello John" into a container on the page. | |||
|
|
|||
| You'll notice that we used an HTML-like syntax; [we call it JSX](https://facebook.github.io/react/docs/jsx-in-depth.html). JSX is not required to use React, but it makes code more readable, and writing it feels like writing HTML. A simple transform is included with React that allows converting JSX into native JavaScript for browsers to digest. | |||
| You'll notice that we used an HTML-like syntax; [we call it JSX](https://facebook.github.io/react/docs/introducing-jsx.html). JSX is not required to use React, but it makes code more readable, and writing it feels like writing HTML. We recommend using [Babel](http://babeljs.io/) with a [React preset](https://babeljs.io/docs/plugins/preset-react/) to convert JSX into native JavaScript for browsers to digest. | |||
There was a problem hiding this comment.
Can we make the Babel link HTTPS too?
|
I don't want to bikeshed on this a lot so let's do it and then please send PRs if you have better suggestions! |
* Replace Starter Kit with doc link * https in Babel link
