Quantcast
Channel: ReScript Forum - Latest posts
Viewing all articles
Browse latest Browse all 1823

State of rescript lib Docs

$
0
0

Hello everyone,

I’m keen to know, how the rescript library authors of you approach documentation for such a lib?

  • Do you just write a (simple?) readme?
  • Do you have api docs? (How? Where?)
  • Do you use doc-comments in rescript files?
  • Do you generate some part of your docs? ( which part? How?)
  • Do you write (all?) docs by hand?
  • Do you use a site-generator? (Which one?)
  • What’s your general approach and thoughts?

The release of rescript-tools marks the date of official doc-gen tooling support.
I started tinkering with doc-gen some time ago and I’d like to know your thoughts, ideas and current pain-points. It would be great to find a consensus what’s the most needed tooling related to docs.


Viewing all articles
Browse latest Browse all 1823

Trending Articles