search

rescript-lang / rescript-lang.org

Official documentation website for the ReScript programming language
https://rescript-lang.org
MIT License
1.85k stars 248 forks source link

pages/docs/react/latest/installation.mdx notes incorrect #453

Closed tb01923 closed 5 months ago

tb01923 commented 3 years ago

Versions

this document could be aided a touch: pages/docs/react/latest/installation.mdx

Two recommednations for improvement. First have folks create a src directory which Test.res is created-within. Second a couple small changes to bsconfig.js to get npx rescript to run without errors:

  1. add a name (e.g. "test-app")
  2. add sources folder (e.g. "src")
{
  "name": "test-app",
  "bs-dependencies": ["@rescript/react"],
  "reason": {"react-jsx": 3},
  "sources": ["src"]
}
fhammerschmidt commented 5 months ago

it says "add the following setting to your existing rescript.json". It's not meant to explain how to create an example from scratch which is explained on the installation page of ReScript itself.