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

Documentation backlog #491

Closed
6 of 10 tasks
necolas opened this issue May 25, 2017 · 5 comments
Closed
6 of 10 tasks

Documentation backlog #491

necolas opened this issue May 25, 2017 · 5 comments

Comments

@necolas
Copy link
Owner

necolas commented May 25, 2017

  • Provide versioned documentation
  • Align with React's README
  • Document Animated (link to RN and add examples)
  • Document ART (link to docs)
  • Create documentation app (remove storybook)
  • Include React Native version compatibility
  • Merge 'examples' and 'docs' directory on master branch
  • Update live examples in documentation
  • Add example on glitch.com
  • Fix online code editor example (i.e., webpackbin; requires React 16 and solution to React 16 migration #364)

Ref #168, #436, #475, #482

@peterschussheim
Copy link
Contributor

@necolas I'd like to help with transitioning off of storybook. Do you have any notes on your ideas for the new documentation app?

@necolas
Copy link
Owner Author

necolas commented Dec 19, 2017

Most of the docs are not coupled to storybook anymore. Replacing storybook could be done with a simple menu + content layout, where the menu is a drawer on smaller screens and fixed in place on wider screens (a bit like the current storybook UI). Storybook still doesn't have a mobile-friendly UI, so I'm still interested in this.

@MoOx
Copy link
Contributor

MoOx commented Dec 19, 2017

I guess you should take a look to https://docusaurus.io if you want something dead simple. Otherwise, I can still help to setup https://phenomic.io (which should be really easy and could use RNW itself for the UI).

@kristerkari
Copy link
Contributor

@necolas It would also be good to have better documentation for supported browsers.

Currently the README just says Browser support: Chrome, Firefox, Safari >= 7, IE 10, Edge.

From that I understand that Android stock browser is not supported, however the code has some references to supporting Android 4 / 4.4:

// Android 4.4 browser
const isPrefixed =
canUseDOM && !document.hasOwnProperty('hidden') && document.hasOwnProperty('webkitHidden');

If Android 4.4 stock is not supported it would be good to clearly document that and remove the references from code. It would also personally for me be interesting to know why Android stock is not supported.

I'm willing to help with documenting that if you let me know what the current browser support is.

@necolas
Copy link
Owner Author

necolas commented Dec 20, 2018

Rethinking how to provide documentation, so closing this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants