Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing API / Component docs #8202

Closed
caabernathy opened this issue Jun 18, 2016 · 4 comments
Closed

Add missing API / Component docs #8202

caabernathy opened this issue Jun 18, 2016 · 4 comments
Labels
Resolution: Locked This issue was locked by the bot.

Comments

@caabernathy
Copy link
Contributor

Reference: https://www.facebook.com/groups/reactnativeoss/permalink/1530162503947045/
See also: https://github.com/facebook/react-native/blob/master/Libraries/react-native/react-native.js

We have some missing reference docs. Some on purpose, others need to be added.

First let's figure out what's missing then go from there.

@caabernathy
Copy link
Contributor Author

@lacker, @JoelMarcey, @vjeux - curious on rehashing thoughts here. Options are:

  1. Automatically show docs based on what's exported in code: https://github.com/facebook/react-native/blob/master/Libraries/react-native/react-native.js
  2. Manually add the ones shown as is being done right now.

I prefer a version of (1) even if we end up documenting APIs, Components that are deprecated or experimental.

@vjeux
Copy link
Contributor

vjeux commented Jun 21, 2016

  1. works for me if you can implement it :)

@lacker
Copy link
Contributor

lacker commented Jul 15, 2016

I did #2 for the ones that work, but still some are missing: ART, Platform, Touchable, Keyboard in particular

@lacker
Copy link
Contributor

lacker commented Feb 9, 2017

We concluded it's nontrivial to add those extras, so I think this issue is no longer too helpful and we should just close it. Issues of the form "component X needs better docs" are still legit though.

@lacker lacker closed this as completed Feb 9, 2017
@facebook facebook locked as resolved and limited conversation to collaborators Jul 19, 2018
@react-native-bot react-native-bot added the Resolution: Locked This issue was locked by the bot. label Jul 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Resolution: Locked This issue was locked by the bot.
Projects
None yet
Development

No branches or pull requests

5 participants