Publish DocDown Commits Into Next Release (0.29) #8480
Merged
Conversation
This file contains 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
Summary: This is a followup to #8010. Troubleshooting has been updated to list only those issues that may affect a user that is setting up their environment. Any issues related to day to day use have been moved or merged into a more relevant doc. Closes #8254 Reviewed By: caabernathy Differential Revision: D3459018 Pulled By: JoelMarcey fbshipit-source-id: dd76097af34bd33dda376fab39fb0f71061ef3e4
Summary: We have enough responses now and we are in the lockdown for improving the documentation. We can add another "did we improve?" survey after lockdown sometime. Closes #8260 Differential Revision: D3463284 Pulled By: JoelMarcey fbshipit-source-id: f2d585a8aa6308de0cce0bea3974b1e7f14d5a6f
Summary: Add a message to let people know they can use the `--simulator` flag to run their apps on different simulators instead of the default "iPhone 6" Closes #8078 Differential Revision: D3464912 Pulled By: JoelMarcey fbshipit-source-id: b59d5061d2b3501618602932fcc285bac99b7573
Summary: Add basic information about the generic `ScrollView` -- talk a bit about how it renders elements and a quick compare against something like a `ListView`. Provide a simple example. Fixes #8261 Closes #8266 Differential Revision: D3465105 Pulled By: JoelMarcey fbshipit-source-id: 3a2e1eac6e877669763fc6b8bb0fc78ebe870ab1
Summary: As part of improving the API and Component reference docs #8154 this pull request adds the following: - jsdoc support for API docs. See the AlertIOS changes as an example. - type definitions support and added to both API and Component docs. This is supported via react-docgen and jsdoc. - better formatting of method properties (now shown in a table). FYI, API and Component docs were previously generated in two different ways. Components were using react-docgen and that basically remains as-is. APIs were using custom parsing code and that's been switched to use a jsdoc parser + react-docgen as an option for typedefs (it could also use the jsdoc parser). Two docs have been updated to showcase how we'd like the new docs to look: - AlertIOS (API): showing method parameters, examples, typedefs, more details overall. - Statusbar (Component): showing method parameters, typedefs, more details overall. **Note**: To convert new API docs to use the new format, add `jsdoc` to the initial file comment. C Closes #8196 Differential Revision: D3465037 Pulled By: lacker fbshipit-source-id: 78415d44bc5be02db802f5b1f7a0b249689abdf7
Summary: The motivation is that the showcase is becoming far too large to be useful. I filtered the apps for, basically, "apps that have some sort of interesting news coverage or technical blog post about them". The UI is a bit updated to also mention something about the information link. I also added the FB app itself. Closes #8263 Differential Revision: D3463856 Pulled By: JoelMarcey fbshipit-source-id: cdd309ba85edca417868f14dee7c772f73af654b
Summary: The motivation is that we haven't changed the copy on the initial React Native landing page since launching, and we have a much clearer view of the React Native value prop now. Themes: 1. React Native is like React but for mobile apps 2. A React Native app is a "real native app" 3. Development is fast 4. You can drop down to normal native development if you need Closes #8291 Differential Revision: D3466855 Pulled By: JoelMarcey fbshipit-source-id: d1a5035640bcd795704d5f830b79e7c3d2e3ab02
Summary: Simplify the sidebar. We have Twitter feed in support. These have a community feel as well. Closes #8287 Differential Revision: D3467042 Pulled By: lacker fbshipit-source-id: 60749d0cb31f284dae7c5402bfcde7b4d01aa32f
Summary: I spent so much time trying to optimize my JS without noticing this. Closes #8285 Differential Revision: D3468707 fbshipit-source-id: bd5ff38ca2501891318b4be3c75bdaa10a4c64da
Summary: The new Handling Touches guide provides an overall view of how touches can be handled. It is meant to be a higher level discussion of basic touch handling, e.g. "how do I implement a button?". The existing Gesture Responder System guide has been moved to the end of the docs and is still available for reference when building custom gesture handlers. Reference: #8160  Closes #8299 Differential Revision: D3469681 Pulled By: JoelMarcey fbshipit-source-id: 3bc18e759b26c2d5c141b626acb433c5e973cef0
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 #8293 Differential Revision: D3469684 Pulled By: JoelMarcey fbshipit-source-id: 4f7830ca10b8e4406df9cec8bf13ff150e355250
Summary: This is an improvement to basic components docs. * I updated the basic components example code to better render components on iOS (added paddingTop). * I also modified the code to allow reader to easily copy, paste, and then run the code in their project if they followed the 'Getting Started' quick start guide. * I also added additional copy to clarify suggested usage/guidelines. Closes #8292 Differential Revision: D3469943 Pulled By: JoelMarcey fbshipit-source-id: 21ff6ee13b59741c43d80aab68a38aace0fbfca6
Summary: This PR adds the interactive [React Native Web Player](http://dabbott.github.io/react-native-web-player/) to the docs. The web player is an embeddable iframe which runs React Native code using components from [react-native-web](https://github.com/necolas/react-native-web). For now, it's primarily for educational purposes, since only the basic components are implemented. Some details: - The iframe is loaded from MaxCDN using rawgit, locked down to a git tag. - Asset paths (i.e. images) are resolved relative to `//facebook.github.io/react-native/` - When viewed on mobile, it falls back to the syntax-highlighted code blocks. The WebPlayer can be inserted into markdown by using the fences: ``` ```ReactNativeWebPlayer import ... AppRegistry.registerComponent ... `` ` ```  I didn't actually add the WebPlayer to any docs pages in this PR. That we c Closes #8328 Differential Revision: D3471527 Pulled By: lacker fbshipit-source-id: 704da41cd77e08c7e2bc820557a74d36e88e8eb7
Summary: TLDR even more docs changes So I created a More Resources doc that aggregates the high-quality-but-off-site stuff. Let's try to put more outlinks there. Also I removed the stuff on Support that was not support, and some misc changes to clean stuff up. Closes #8329 Differential Revision: D3471669 Pulled By: JoelMarcey fbshipit-source-id: 54edd543ced1b3a8f3d0baca5475ac96bae6e487
Summary: > ListView is not supported by React Native Web as of yet, so it will not have it. Closes #8331 Differential Revision: D3472019 Pulled By: lacker fbshipit-source-id: e5fb430b6c8f4d437943c159beb00b9d9252c92d
Summary: Related to #8203 to update the Navigator component reference doc. **Test plan (required)** Started up the website and checked: http://localhost:8079/react-native/docs/navigator.html  **Note** The code is not Flow-ified so depended on jsdoc formatting to get the method parameter types. There's a current issue with handling optional types via react-docgen which parses components. There's an open PR to look into this: reactjs/react-docgen#89. When that's resolved the `replaceAtIndex` method parameter type that's documented for `cb` needs to be updated to make it optional. Closes #8318 Differential Revision: D3471185 Pulled By: JoelMarcey fbshipit-source-id: 99f85ee2ab00dc200cf2812cce5b3ccec743d6a0
Summary: The motivation is that the getting started page was not working in some cases in Firefox. This line of code appears to be at best a no-op, at worst fails in Firefox, since "event" is undefined. Closes #8335 Differential Revision: D3473333 Pulled By: JoelMarcey fbshipit-source-id: 40581e83126675aa072c6ee25609cfb787015ce7
…example Summary: 1. Animation guide page is the only place where Flowtype is used, it would be better to remove it to prevent some confusion. 2. ES2015 classes in guidelines docs pages and fixed some typos **Test plan (required)** Should i write any tests for this? Closes #8339 Differential Revision: D3474192 Pulled By: bestander fbshipit-source-id: 5531d1e399eaed0952732ac2e0bd1effc72d00a8
Summary: Ensure all `props` have documentation. Add more details to current `props`. Provide more information to the API in general. > Would like to try to integrate the React Native Web Player for the initial > example, but not right now. Closes #8341 Differential Revision: D3475105 Pulled By: caabernathy fbshipit-source-id: 00ad30b2359831740715517278bec1d0231e089d
Summary: Added some documentation to the `RunningOnDeviceAndroid.md` with screenshots to set custom port Closes #8355 Differential Revision: D3475846 Pulled By: mkonicek fbshipit-source-id: 73675b19e2bb93c859bda239f228da0883f0e305
Summary: These pages should sufficiently give a beginner enough information to make most layouts in React Native. They should go after the basics-style page, whenever that is ready. Having a single page for Layout was too much, so I split it into two: Dimensions and Layout.   lacker Closes #8364 Differential Revision: D3477147 Pulled By: lacker fbshipit-source-id: 1ef31ac0a64e43166a7581b38fa8263282672eeb
Summary: Closes #8368 Differential Revision: D3477381 Pulled By: caabernathy fbshipit-source-id: 0c43a9b8309db8f268a2776ebff2b4e52df559df
Summary: Closes #8366 Differential Revision: D3477409 Pulled By: caabernathy fbshipit-source-id: 5906e8dffc7884a6ed527fada5f907702a72c08f
Summary: Closes #8365 Differential Revision: D3477411 Pulled By: caabernathy fbshipit-source-id: 26214fcf13c9e1352e198f34fcd6f5e88f1fe2da
Summary: Closes #8367 Differential Revision: D3477404 Pulled By: caabernathy fbshipit-source-id: 16c279853b5c7a2d24033ef0d987da52dd148b24
Summary: Closes #8363 Differential Revision: D3477431 Pulled By: caabernathy fbshipit-source-id: 86ee5efb84e50609fbfae82102b1dc61fea69f05
Summary: Reference: #8203 Changes made: - Added more to the intro section and updated the intro examples to ES6 - Added more details to prop explanations - Added parameter descriptions for methods **Test plan (required)** Ran the website locally and checked: http://localhost:8079/react-native/docs/navigatorios.html  Closes #8334 Differential Revision: D3476066 Pulled By: JoelMarcey fbshipit-source-id: 9fcefe3f9d59008d8c72683c57cb004d1f185f62
Summary: Closes #8395 Differential Revision: D3482652 Pulled By: lacker fbshipit-source-id: 0bf8955341221b74f69ba24dcf5ab332c910a52c
Summary: - Make the examples runnable (both copy/paste and with the web player) - Add a bit more information in props where needed. Closes #8392 Differential Revision: D3482747 Pulled By: caabernathy fbshipit-source-id: 8f2d812efc1efb3f14db45b5c054ce0d5c14f5f5
Summary: Closes #8429 Differential Revision: D3487369 Pulled By: lacker fbshipit-source-id: 59b32f2a2a67370192c91dc43da3d4b76a43b810
Summary: Closes #8450 Differential Revision: D3488018 fbshipit-source-id: a30269c89e87b546f77da7a32b1c4c65d978459d
Summary: And more delineated from other parts of the method information. Hopefully this makes it easier to parse through. Closes #8421 Differential Revision: D3488251 Pulled By: JoelMarcey fbshipit-source-id: 44f2ed00b16849396cac94fd46567eaab48c50f3
Summary: Switch web player cdn to npmcdn per discussion with lacker. This will make the url agnostic to who owns the git repo. Closes #8426 Differential Revision: D3488755 Pulled By: lacker fbshipit-source-id: b54dd4428a48c8a5a15b0b38ee0564d119916f9b
Summary: Add note associating error message to "adb reverse" command. When I first ran a React Native app on my Android phone, I received a cryptic "bridge configuration isn't available" error. After some research, I discovered that the "adb reverse" command mentioned further down on the page resolved the problem. Closes #7725 Differential Revision: D3491577 Pulled By: JoelMarcey fbshipit-source-id: 34c580acd6bf3e7788b674bd0b41bc5a1023b010
Summary: Not a big deal, I was just going through the tutorial trying to figure out which doc was the most boring, and improve it a bit. IMO now the example is slightly funnier, and it mentions onSubmitEditing which in practice is probably a more useful callback. Closes #8447 Differential Revision: D3491938 Pulled By: JoelMarcey fbshipit-source-id: 3bd0f5762dc4db4a85c9d5badb6c005f4b8c52f4
Summary:
This updates the documentation for the `Text` component itself and the embedded `Text.md` that goes with it.
- React Native Web Player
- Document all props
- NOTE: I actually added a new prop to `Text` called `accessible` since it was set by default and thus shown in the Props list
in the original documentation (but with an empty description).
- Stylistic fixes
Closes #8445
Differential Revision: D3493112
Pulled By: JoelMarcey
fbshipit-source-id: b428d4eb09065db5c6cb1ae5524ad22084fd2a82
Summary: Ref: https://github.com/facebook/react-native/pull/8392/files/7e7c2b5d57afe451dc5b6ede6b419819e3ac7fbd#r68444537 Ref: https://github.com/facebook/react-native/pull/8392/files/7e7c2b5d57afe451dc5b6ede6b419819e3ac7fbd#r68444442 Closes #8476 Differential Revision: D3494641 Pulled By: JoelMarcey fbshipit-source-id: 9a75ff66ccb895deb2f5027bdffe5d5bfe898e41
|
By analyzing the blame information on this pull request, we identified @lacker and @RetroPoktan to be potential reviewers. |
ghost
added
GH Review: review-needed
CLA Signed
|
As far as I can tell from my mere-human reviewing, this has the stuff I'm aware of in it. So LGTM. I'll leave it to you to figure out when to ship |
JoelMarcey
assigned ericnakagawa, lacker, hramos, caabernathy and bestander and unassigned lacker, caabernathy and bestander
|
It all looks good to me. |
|
Ok, let's do this. |
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.
We want to get the results of our documentation lockdown into the hands of users asap without them having to go to
next.0.29is planned to be released within the next several days, so this will get it in the hands of users sooner rather than another 2+ weeks.This interactive rebased all of our docdown commits onto the
0.29-stablebranch. e.g.,Test Plan:
The site looks the same as it currently does at http://facebook.github.io/react-native/releases/next/