cats-parse icon indicating copy to clipboard operation
cats-parse copied to clipboard

set up a documentation site

Open johnynek opened this issue 4 years ago • 2 comments

have a doc site that publishes and looks similar to the cats documentation (logos etc...)

johnynek avatar Oct 30 '20 22:10 johnynek

I'm a big fan of docusaurus, as I do personally find the end result to be more navigable (new word for me!), due to the prevalence of docusaurus documentation sites. I remember @raasAhsan mentioning that the aim is for cats-effect to use docusaurus for the v3 docs, which appears to be corroborated by this commit https://github.com/typelevel/cats-effect/commit/a2f1d1996f67c09fd2f35c43263f5c8891a5d076 .

Coursier has some scripts to handle setting up versioned docs, which we could lift, see: https://github.com/coursier/coursier/blob/master/scripts/shared/Docusaurus.sc .

I don't know how this stuff would fit into sbt-github-actions (due to unfamiliarity), but it doesn't seem insurmountable.

Edit: unless someone yells, I'll start looking at this stuff this week (no promises though :P).

Slakah avatar Nov 02 '20 09:11 Slakah

Thanks! That's great.

I'm not too opinionated. I did paradox in a project recently just I have only JVM dependencies.

johnynek avatar Nov 02 '20 16:11 johnynek