Document usage with opam + npm

Open
#717 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
react
Domain
documentation

Research direction

Read the README and docs to find the existing installation and usage guidance for the opam-based workflow. Document that users must add react manually to package.json and state the supported ReactJS version; the work is done when both documentation locations explain these requirements.

Written by the indexing model from the issue text.

Description

docs

As these bindings are now targeting Melange, the main supported workflow will be consuming it through opam. This means users of reason-react will need to add react as a dependency on their package.json manually. Similarly to how OCaml native bindings do with underlying dependencies.

This should be documented in the README and docs, including the version of ReactJS that is supported (I think 16 at the moment).

Dominant language
Reason
Stars
3.3k
Forks
344
No merged PRs in 30d

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.

More from reasonml/reason-react

All issues in reasonml/reason-react

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.