rescript-lang / rescript-lang/rescript-lang.org

Improve Clarity and Guidance in ReScript Installation and Quickstart Documentation

Open
#896 0 comments 0 reactions 1 assignee View on GitHub

@jderochervlk is already working on this.

Since May 7, 2025.

Dominant language
MDX
Stars
1.9k
Forks
260
Avg merge
3d 9h
Merged PRs (30d)
17

Description

Hi. Thanks for your work. I want to try out ReScript and have followed the installation instructions provided here.

Post-Installation Guidance:

After installation, the page mentions making a build or starting a watcher. However, there are no clear next steps provided, such as a quickstart guide. This makes it difficult to know what to do next without having to browse the entire documentation.

Project Initialization Confusion:

The difference between starting a project with npm create rescript-app@latest and installing npm install @rescript/react is not clear. The first command already creates the @rescript/react dependency in the rescript.json file, but this is not explained. The rescript.json file is mentioned without any explanation of its purpose or contents.

Suggestions for Improvement:

  • Include a clear quickstart guide after the installation steps.
  • Clarify the differences between npm create rescript-app@latest and npm install @rescript/react.
  • Provide an explanation of the rescript.json file and its role in a ReScript project.
  • Consider revising the documentation to be more beginner-friendly and not assume prior knowledge of the JavaScript ecosystem.

Thank you for considering these improvements.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.