A better Documentation Platform for Reason
reasonml.org is a community project dedicated to a better doc
experience for the Reason & BuckleScript platform and is currently a Work in
Project announcements and a high level roadmap (1-2 years) are documented here.
In case you are looking for the current official docs, here is a good reference sheet:
Current Focus / Open Tasks
Following sections are just a rough outline on what needs to be done in the next steps:
Upstream the Reason language docs from reasonml.github.io
Upstream the BuckleScript docs from bucklescript.github.io
Merge Reason's & BuckleScript's docs into one cohesive document
Deep dive into
odocto extract API documentation from the BuckleScript modules' source code
Upstream our markdown curated changes of the Belt / Js modules into the BuckleScript source code
Improve the BuckleScript generated playground bundle for our use-cases (see issue)
Improve the workflow for generating third-party package bundles (define a protocol on how to hook those into the playground engine)
Integrate the Playground Engine + ReasonReact 3rd Party dep into the UI (see the NIT playground for inspiration)
Build the custom Search overlay (see the design)
Add Algolia's OSS webscraper engine and wire it up with our UI
Generate indexing data via
odocand use a paid plan for Algolia's indexing service
Tweak UI for API vs. whole page searches
How to contribute
We want to thank our sponsors for making this project possible.
We are always looking for new sponsor partners to continously improve our documentation experience. Please refer to the Reason Assocation's donation section for more information.