Replace Starter Kit with doc link #8682

Merged
merged 2 commits into from Jan 4, 2017

Projects

None yet

4 participants

@gaearon
Member
gaearon commented Jan 4, 2017
  1. Fixes README to point to "Intro to JSX" rather than "JSX in Depth"
  2. Remove "A simple transform is included" since it's not included
  3. Replaces Installation paragraph with a starter kit to point to Installation sections in docs
  4. Removes the starter kit page
  5. Removes the starter kit build step
@gaearon gaearon requested review from spicyj, acdlite, and aweary and removed request for spicyj Jan 4, 2017
@gaearon
Member
gaearon commented Jan 4, 2017

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.

@bvaughn

I dig this change. 😄

-```
+* [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)
@bvaughn
bvaughn Jan 4, 2017 Contributor

These all 3 point to essentially the same place. Is there value in having them as separate links?

@aweary
aweary Jan 4, 2017 Collaborator

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.

@bvaughn
bvaughn Jan 4, 2017 Contributor

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. 😄

@gaearon
gaearon Jan 4, 2017 Member

I wanted to highlight that React can be used in all these scenarios right in README.

README.md
@@ -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.
@aweary
aweary Jan 4, 2017 Collaborator

Can we make the Babel link HTTPS too?

@aweary
aweary approved these changes Jan 4, 2017 View changes
@gaearon
Member
gaearon commented Jan 4, 2017

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!

@gaearon gaearon merged commit 0e6f784 into facebook:master Jan 4, 2017

1 check was pending

ci/circleci Your tests are queued behind your running builds
Details
@gaearon gaearon deleted the gaearon:remove-starter branch Jan 4, 2017
@gaearon gaearon added a commit that referenced this pull request Jan 4, 2017
@gaearon gaearon Replace Starter Kit with doc link (#8682)
* Replace Starter Kit with doc link

* https in Babel link
1f56a6d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment