Provide API docs

Open
#473 9 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
react
Domain
documentation

Research direction

Start by reviewing the existing ReasonReact website documentation, the ReactJS site, the ReasonReact source, and BuckleScript's online API documentation. Define the API surface and documentation location before writing content; done means the ReasonReact API is documented online and is usable without consulting the source.

Written by the indexing model from the issue text.

Description

docs help wanted

I've just started out with React and ReasonML and read through all the docs on the ReasonReact website. However, I was unable to find any online documentation for the ReasonReact API. I've had to try to match up information from the ReactJS site or fall back to the ReasonReact source. While this works, it'd be really nice if the API documentation was available online, much like BuckleScript has.

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.