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 for Revery.UI #810
Comments
Thanks for reporting :) We use odoc to generate documentation. Their is some work to allow to generate programmatically the .mld (and the whole website) so our docs pages will stay up to date. I don't know the state/branch where we can see the progress done. We can add it manually for now. Do you want I do ? In case we have forgotten some other modules you can just have the list of argument by peeking inside the source. We respect the rule: "One component per file" so the Opacity component is defined here https://github.com/revery-ui/revery/blob/master/src/UI_Primitives/Opacity.re#L4 You can use the "find file" feature of GitHub to help you :) |
I'm happy to do it if that's what you mean. I worked out how to build the docs already. |
Ok open a PR then :) I will review and merge if it is ok :) |
all the links to hooks are also broken in the table of contents. #811 has some code to fix this but the PR was closed :( |
I cloned and built
revery-quick-start
and started looking throughApp.re
to see how it all works. I noticed it opensRevery.UI
but there didn't seem to be any documentation for things likeOpacity
andView
on https://www.outrunlabs.com/revery/api/revery/. Poking around I managed to guess the URL and found them at https://www.outrunlabs.com/revery/api/revery/revery_ui/ and https://www.outrunlabs.com/revery/api/revery/revery_ui_primitives/Looks like https://github.com/revery-ui/revery/blob/master/src/index.mld needs to be updated. I've got the docs building locally now. I can open a PR with them added if you like.
The text was updated successfully, but these errors were encountered: