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

Documentation update (mentions Melange and fixes a few things) #765

Merged
merged 37 commits into from
Nov 3, 2023
Merged

Documentation update (mentions Melange and fixes a few things) #765

merged 37 commits into from
Nov 3, 2023

Conversation

davesnx
Copy link
Member

@davesnx davesnx commented Nov 3, 2023

This PR updates the Reason documentation with a few aditions and a few changes:

  • Mention melange as a partner project in a few different places
  • Creates a /melange page as an entry point for compiling to js
  • De-prio esy installation into installation-esy and removes it from the sidebar
  • Makes opam the default installation under installation
  • Mentions dune and opam (introducing both tools, in both what-and-why and installation
  • Removes “rebranding to ReScript” warnings and points to Melange docs where matters
  • Improves the “What and why”
    • Adding the Jordan’s keynote video
    • Adding key points
    • and explaining different environtments
  • Improves JSX explanation
  • Creates a get-started page with minimum links to playground or installation (more to add here)
  • Creates a refmt page where explains the flags
  • Creates a rtop page
  • Brings syntax cheatsheet back (comparision from JS)
  • Keeps the link to ReScript on converting-from-js
  • Brings back some FAQ questions that were removed on the split PR

Deployed here: https://reasonml-github-io-reasonml.vercel.app/docs/en/what-and-why


Copy link
Contributor

@thatportugueseguy thatportugueseguy left a 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).
Copy link
Contributor

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?

Copy link
Member Author

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

Copy link
Member Author

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

Copy link
Contributor

@jchavarri jchavarri left a 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
Copy link
Contributor

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

Copy link
Member Author

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.

davesnx and others added 2 commits November 3, 2023 21:22
Co-authored-by: José Nogueira <ze@thatportugueseguy.com>
Co-authored-by: Javier Chávarri <javier.chavarri@gmail.com>
@davesnx davesnx merged commit 53dbec8 into reasonml:source Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment