-
Notifications
You must be signed in to change notification settings - Fork 399
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 update (mentions Melange and fixes a few things) #765
Conversation
… Improve-documentation-and-add-melange * 'source' of github.com:/reasonml/reasonml.github.io: Replace yarn with npm on README Use npm instead of yarn Proofread README by andyg0808
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome stuff! Just added a couple of annotations, i couldn't go in in full detail, but lgtm. 😁
|
||
> Melange strives to provide the best integration with both the OCaml and JavaScript ecosystems | ||
|
||
If you have experience with JavaScript and the ecosystem we recommend Melange, over other alternatives such as [Js_of_ocaml](compiling-to-js-with-jsoo.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks broken: https://reasonml-github-io-reasonml.vercel.app/docs/en/compiling-to-js-with-jsoo
is it intended to be outside of the docs list?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe we should add in on the sidebar (which will fix this issue) but since it's a little rough page I'm unsure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the link, when this page is ready can be pointed out in the sidebar and in the content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! I think the links to melange could be updated from 2.0.0 to 2.1.0 now that this version of the docs is out.
@@ -2,73 +2,102 @@ | |||
title: Installation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see this section as "Native installation" and the one in the Melange section as "Js installation". Not sure if it'd be worth to separate these 2 cases more clearly (prob to do somewhere in the future).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The biggest difference is just melange right?
We might need to revisit this in the future, indeed.
Co-authored-by: José Nogueira <ze@thatportugueseguy.com>
Co-authored-by: Javier Chávarri <javier.chavarri@gmail.com>
This PR updates the Reason documentation with a few aditions and a few changes:
installation-esy
and removes it from the sidebarinstallation
Deployed here: https://reasonml-github-io-reasonml.vercel.app/docs/en/what-and-why
reason
needs to be added a dependency #619npm install
to quickstart script #713