melange-re.github.io icon indicating copy to clipboard operation
melange-re.github.io copied to clipboard

Published 20 hours ago • verified publisher icon melange-re

Documentation for reason/jsx syntax?

Open ajstrand opened this issue 2 years ago • 6 comments

Should there be a section in the website for the react-ppx bindings since those are distributed as a package on the Ocaml package site?

I imagine the existing reason-react site might get out of date at some point.

Is this something that an outside contributor(like myself) could submit as a PR?

ajstrand avatar Jun 12 '23 19:06 ajstrand

This is a great point. @davesnx is working on the wider reason-react documentation effort, so I'll defer to him.

anmonteiro avatar Jun 12 '23 19:06 anmonteiro

Hi, I'm working on the docs for reason-react which for now will remain it's own place there, but in the future I can imagine that they embed in the melange docs.

It's very recent work but I would love to have some help polishing the documentation, draft PR here: https://github.com/reasonml/reason-react/pull/734

Feel free to contact me in Discord https://discord.com/users/122441959414431745 to coordinate!

davesnx avatar Jun 13 '23 04:06 davesnx

@davesnx ive been away from my personal computer this week visiting family, but when I get back home this weekend, I’ll set up the docs locally and reach out on discord if I have suggestions. From what I read of the updated docs site, it looked really good! Everything seemed very well explained, as far as I could see.

ajstrand avatar Jun 15 '23 15:06 ajstrand

Merged the changes already: https://reasonml.github.io/reason-react and I'm looking for general feedback.

Maybe a link from Melange docs into ReasonReact might be necessary at some point, but so far the situation is good enough IMO.

davesnx avatar Jun 15 '23 15:06 davesnx

We link to reason-react docs in a few places:

https://github.com/melange-re/melange-re.github.io/blob/6945e9c83b50021d3cf6d3c3ad1000f34c49fe67/docs/melange-for-x-developers.md#L26

https://github.com/melange-re/melange-re.github.io/blob/6945e9c83b50021d3cf6d3c3ad1000f34c49fe67/docs/melange-for-x-developers.md#L519

https://github.com/melange-re/melange-re.github.io/blob/6945e9c83b50021d3cf6d3c3ad1000f34c49fe67/docs/communicate-with-javascript.md#L634

Should we make that connection more prominent? Personally, I think we should keep the melange.re docs limited to the compiler, and leave library docs like ReasonReact on their own site, but we can add a section "Notable libraries and packages" to https://melange.re/unstable/community/#resources?

jchavarri avatar Aug 25 '23 14:08 jchavarri

Probably linking to Reason JSX documentation sounds a good idea, or even having a "Reason" page on Melange docs

davesnx avatar Oct 26 '23 07:10 davesnx