Commit Graph

28 Commits

Author SHA1 Message Date
Hector Ramos b1ecb84c97 Standardize on using AwesomeProject for AppRegistry calls.
Summary:
We've noticed that many newcomers paste sample code straight into a project created using `react-native init AwesomeProject`, but the sample code assumes the user is creating a new project for each example. This PR makes it so that these samples can be pasted into the same project from the Getting Started.
Closes https://github.com/facebook/react-native/pull/14264

Differential Revision: D5149746

Pulled By: hramos

fbshipit-source-id: cae95ab5b7baf64ddd9fe12d342ad05f785bb381
2017-05-30 14:20:42 -07:00
Adam Perry ca2d57c744 Update examples in docs and address version lag of CRNA
Summary:
cc hramos

Pretty sure I've hit all of the places where AppRegistry is called in CRNA-pastable examples. Let me know whether you think we need to approach the version lag differently, I figure a caveat is as natural a place to call it out as any.

If you end up finding anything else that needs tweaking before cherry picking, I'm happy to push that up here too.
Closes https://github.com/facebook/react-native/pull/13744

Differential Revision: D5071038

Pulled By: hramos

fbshipit-source-id: 4a4a6f2a73079aca627f17d75a4e4b395ecbd4a8
2017-05-16 23:51:28 -07:00
Hector Ramos 3f6476fc5e Tweak presentation of Colors guide.
Summary:
Explain a bit more how these are used.
Closes https://github.com/facebook/react-native/pull/12753

Differential Revision: D4663972

Pulled By: hramos

fbshipit-source-id: acbda6593e3f2a01776d2208f6ef3bc69bca0eef
2017-03-06 18:01:06 -08:00
Paul Mestemaker 8378f0f9f7 Ensure documentation has consistent relative links
Summary:
Explain the **motivation** for making this change. What existing problem does the pull request solve?

I had tried fixing a broken link in a previous commit (#11453). My commit was merged, but it did not resolve the underlying problem. I have looked into how links should be formed for the docs and have fixed the original problem as well as updated all other links to be consistent.

Previous link formats:

- /docs/sample.html <-- broken link
- sample.html <-- broken link
- https://facebook.github.io/react-native/docs/sample.html <-- works
- /react-native/docs/sample.html <-- works
- docs/sample.html <-- works (permalink format)

This PR updates all links to the permalink format.

**Test plan (required)**
I ran the website locally and manually tested half of the links in each category. They all worked.
```
$ cd website
$ npm install && npm start
```
Closes https://github.com/facebook/react-native/pull/12064

Differential Revision: D4489153

Pulled By: mkonicek

fbshipit-source-id: bf0231d941ba147317595c3b3466dc579a887169
2017-01-31 12:13:31 -08:00
Matt Revell 99c75f1942 Minor grammatical change with respect to camel casing.
Summary: Closes https://github.com/facebook/react-native/pull/10736

Differential Revision: D4130609

fbshipit-source-id: 0ddbd86ed55a4f2ea588ceab686e5afa317e4a0c
2016-11-04 02:43:38 -07:00
Andy Denmark f067811cd2 Small typo s/they/the/
Summary: Closes https://github.com/facebook/react-native/pull/8813

Differential Revision: D3572677

Pulled By: sdwilsh

fbshipit-source-id: a2b2b38e64b9575a8b4bcaeb941a34470fc6f1e1
2016-07-15 13:58:39 -07:00
Joel Marcey b1e49832ef Make prev links work in guides and APIs.
Summary:
We had rendering support for prev links, but we never had any previous links in our metadata. Only next links. This adds that support to both Guides and APIs.

**For guides**: `previous` is manually inserted into the metadata of the actual markdown file.
**For APIs/Components**: `previous` is established via code within `extractDocs.js`

> This isn't totally perfect. For example, the transition from the last guide to the first API/component has a next link from the guide, but not a previous link from the API since the way you get the previous links are different from guides and APIs. But this gets us really close.
Closes https://github.com/facebook/react-native/pull/8754

Differential Revision: D3557972

Pulled By: hramos

fbshipit-source-id: e270bb51e7a4f59f61dad28ae0928d27d0af3d4a
2016-07-13 14:58:27 -07:00
Kevin Lacker bfb4c054f4 Make "The Basics" flow like a linear tutorial
Summary: Closes https://github.com/facebook/react-native/pull/8429

Differential Revision: D3487369

Pulled By: lacker

fbshipit-source-id: 59b32f2a2a67370192c91dc43da3d4b76a43b810
2016-06-26 12:43:25 -07:00
Kevin Lacker e3f96acf26 Make a new "Style" doc that's in The Basics and uses the RNWP
Summary:
The example uses StyleSheet.create and also arrays-of-styles. I think this covers everything the old one did, but in simple-enough-for-the-basics form, so I removed the old one. I also reordered so that "Style -> Dimensions -> Layout" is the flow for learning "Styley" things.
Closes https://github.com/facebook/react-native/pull/8379

Differential Revision: D3478384

Pulled By: caabernathy

fbshipit-source-id: 158f0f0367c8eb8b2b24feda0d8d7a533fd7af4d
2016-06-23 14:43:35 -07:00
Joel Marcey 109e3d79cc Remove Polyfills section from sidebar
Summary:
Some of these will be in basics, guides and apis instead. One less layer
of confusion.

> Note: APIs are not totally alphabetical any longer -- but neither were
Polyfills. We can fix that in `extractDocs.js` maybe. But not worth doing
in this pull request, imho.
Closes https://github.com/facebook/react-native/pull/8293

Differential Revision: D3469684

Pulled By: JoelMarcey

fbshipit-source-id: 4f7830ca10b8e4406df9cec8bf13ff150e355250
2016-06-22 09:28:28 -07:00
Konstantin Raev 6f1417c849 CI now builds docs website and deploys it to /%version% path
Summary:
Copy of #5760 reverted merge.

We need to preserve history of docs changes on the webserver.
The goal is to allow users to browse outdated versions of docs.
To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut.

I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it.

How it works:

1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder.
Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL.
All relative URLs will work within that website

2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder.
Github will serve this website from https://facebook.github.io/react-native/releases/v
Closes https://github.com/facebook/react-native/pull/5873

Reviewed By: svcscm

Differential Revision: D2926901

Pulled By: androidtrunkagent

fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1
shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 06:17:42 -08:00
Alex Kotliarskyi e73b08fc06 Document new asset system 2015-11-05 16:10:05 -08:00
Brent Vatne debd5b0942 [Docs] Remove Transforms from sidebar, add to Style 2015-05-07 16:05:30 -07:00
Christopher Chedeau 3f0e3b7d5e Merge pull request #312 from tako-black/fix_typo
fix typo
2015-04-03 10:06:21 -07:00
tako-black 399ace3733 change singular 2015-04-01 18:56:10 +09:00
tako-black 80baec3bb6 change words 2015-04-01 08:17:13 +09:00
John Wu 78f0c7178f Change links to doc instead of js
Change links to doc instead of js
2015-03-31 05:32:08 +08:00
John Wu 0699b731af Document supported CSS properties
Add links to source code that shows supported CSS properties. It will be painful if we don't know what is supported.

Given that CSS properties support may be ever changing, I decided to document links to source code directly.
2015-03-30 10:01:27 +08:00
tako-black fb9bacdf2d fix typo 2015-03-27 14:33:27 +09:00
Eric Vicenti b331a34af6 First pass at gesture responder guide 2015-03-25 15:19:05 -07:00
Christopher Chedeau 4eab005009 Improve style docs 2015-03-25 11:36:37 -07:00
Alex Kotliarskyi 822e659177 Add Native Modules (iOS) guide 2015-03-21 11:39:34 -07:00
Christopher Chedeau 4f8a86e8d7 Website tweaks 2015-03-21 10:59:41 -07:00
Christopher Chedeau f598f05cc5 [Website] Put all the guides in the table of content 2015-03-13 21:30:00 -07:00
Christopher Chedeau 889a30aabd Update Style.md 2015-02-22 08:46:54 -08:00
Christopher Chedeau fac2c8bc18 Update Style.md 2015-02-22 08:46:35 -08:00
Christopher Chedeau 1919c7ba2f Update Style.md 2015-02-22 08:43:27 -08:00
Christopher Chedeau 517343a751 Rename Styles.md to Style.md 2015-02-22 08:42:54 -08:00