Redo the documentation #299
Labels
documentation
f#
Applies to the F# variant
help wanted
Extra attention is needed
ocaml
Applies to the OCaml version
rescript
Applies to the rescript version
Milestone
Currently, the documentation is generated by parsing code and generated files and converting it into model.json, which is then used to generate website code. This means that the .mli files are the source of truth, and it has the advantage of using the exact generated output.
There are some disadvantages to this approach though:
I propose we take the opposite approach:
Other goals:
Alternatively, instead of generating our own code, we could use output from each language's own documentation toolchain (rescript currently uses odoc as well though), and either link to it from the website or embed it somehow.
The text was updated successfully, but these errors were encountered: