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

Improve Clarity and Guidance in ReScript Installation and Quickstart Documentation #896

Open
ElielHdez opened this issue Jul 12, 2024 · 0 comments
Milestone

Comments

@ElielHdez
Copy link

ElielHdez commented Jul 12, 2024

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.

@fhammerschmidt fhammerschmidt added this to the v12.0 milestone Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants