search

rescript-react-native / rescript-react-native.github.io

Official Website
https://rescript-react-native.github.io
MIT License
12 stars 12 forks source link

Website: Most component do not have documentation? #24

Open jaredramirez opened 3 years ago

jaredramirez commented 3 years ago

The problem

Almost all of the of the React Native component documentation is not available on the website.

How to reproduce

Navigate to: https://rescript-react-native.github.io/docs/keyboardavoidingview, or most other components, and see that there is no documentation. The only one with documentation I've come across is: https://rescript-react-native.github.io/docs/pressable.

Expected behavior

I'd expect at the very least the component definition so I can see the prop names for the bindings, or more ideally the props + an example usage + link to official RN documentation.

Actual behavior

No documentation at all.

I often have to open the source code to figure out how to use a component. It seems pretty unideal

Environment

Firefox: 91.0

or

Chrome: 92.0.4515.131

MoOx commented 3 years ago

Help on the documentation is more than welcome! Until it's done in all places, maybe we could tweak the website to show the source like it was before we switched to docusaurus. PRs always welcome!