Documentation for Revery.UI

[wezm]

I cloned and built revery-quick-start and started looking through App.re to see how it all works. I noticed it opens Revery.UI but there didn't seem to be any documentation for things like Opacity and View 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.

[Et7f3]

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 :)

[wezm]

We can add it manually for now. Do you want I do ?

I'm happy to do it if that's what you mean. I worked out how to build the docs already.

[Et7f3]

Ok open a PR then :) I will review and merge if it is ok :)

[chinwobble]

all the links to hooks are also broken in the table of contents. https://www.outrunlabs.com/revery/api/revery/ If you click on animation, reducer, etc they are broken.

#811 has some code to fix this but the PR was closed :(