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

Website: Most component do not have documentation? #24

Open
jaredramirez opened this issue Aug 17, 2021 · 1 comment
Open

Website: Most component do not have documentation? #24

jaredramirez opened this issue Aug 17, 2021 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@jaredramirez
Copy link

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

@jaredramirez jaredramirez changed the title Website: No of the component documentation? Website: Most component do not have documentation? Aug 17, 2021
@MoOx
Copy link
Member

MoOx commented Aug 26, 2021

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!

@MoOx MoOx added enhancement New feature or request help wanted Extra attention is needed labels Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants