rho icon indicating copy to clipboard operation
rho copied to clipboard

Hugo/Tut Documentation

Open zarthross opened this issue 9 years ago • 3 comments

Currently it appears the only documentation is on the Wiki and in the code as examples. Can we get some documentation similar to how Http4s is doing their documentation now? They just updated their documentation to a combination of Hugo and Tut so they have both versioned documentation for their api's and a nice static website for the rest.

zarthross avatar Dec 29 '16 14:12 zarthross

Brainstrorming:

  1. Bring rho into http4s repo. Rho doesn't work in 2.10, which is still needed by some people, so that would require something like sbt-doge. I'd also prefer to move away from the monorepo in time.

  2. Extract http4s documentation plumbing as an sbt plugin. This is how we roll at work.

  3. Get real fancy and have rho publish into http4s docs. Probably builds on top of 2, but is the hardest.

rossabaker avatar Dec 29 '16 14:12 rossabaker

IMHO, 2/3 are better than 1. I prefer to avoid the monorepo if possible as it allows RHO to iterate somewhat quicker and more independently from Http4s.

zarthross avatar Dec 29 '16 15:12 zarthross

+1 for option 2.

bryce-anderson avatar Dec 30 '16 17:12 bryce-anderson