[DEV] Documentation / January 2021 Roadmap

Hi everyone,

After a pretty lengthy ReScript documentation discussion I realized that it might be a good idea to spend some more time on project planning, writing down tasks, and getting the documentation roadmap in a more transparent shape, so everyone knows what’s the plan and where it is going.

This plan was also made so outside contributors can see how they can help to speed up the process of getting the docs feature complete. Mostly it’s just a collection of tasks I committed to complete until the estimated deadline.

2020 January Release / Overview:

  • Estimated Deadline: Jan 31, 2021
  • Revamped rescript-react docs + initial rescript-react release
    • New structure that goes into each React feature (pretty much a rewrite)
    • All docs written in ReScript syntax
    • Removes deprecated Record API / jsx v2 based content
    • Graceful migration plan from reason-react to rescript-react
  • Syntax / Compiler Feature parity
    • Documenting all the important features that are exposed by the ReScript syntax and compiler
  • Removing outdated content from the current ReasonML docs and allow a clean separation of both platforms (ReScript / OCaml / Native), while making sure nobody gets lost

The rescript-lang.org repository now features a Github Milestone to keep track of the progress:
2021 January Release Milestone

For those who want to help, check out the issues that are tagged with help wanted. I hope this makes it easier to see what we are working on, and I am really looking forward to a really nice documentation platform!

Cheers

21 Likes

Cool man, that is a really good idea.

The bigest deal for me is the reScript-React.

even tho i havent started learning them : D
iam planing to soon tho, when i’ll begin working on my final year project.

also might have more contributers that way.

Thank you guys for all the effort, i really appreciate it, others too iam sure.

Thank you for this! I would love to contribute! Glad that I could spark some discussion.

I’ve been in the middle of moving house but I think that I’ll have more bandwidth next week. I haven’t forgotten about this, @ryyppy!