Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

set up a documentation site #7

Open
johnynek opened this issue Oct 30, 2020 · 2 comments · May be fixed by #39
Open

set up a documentation site #7

johnynek opened this issue Oct 30, 2020 · 2 comments · May be fixed by #39

Comments

@johnynek
Copy link
Collaborator

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

@Slakah
Copy link
Collaborator

Slakah commented Nov 2, 2020

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 typelevel/cats-effect@a2f1d19 .

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).

@johnynek
Copy link
Collaborator Author

johnynek commented Nov 2, 2020

Thanks! That's great.

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

@Slakah Slakah linked a pull request Nov 4, 2020 that will close this issue
7 tasks
This was referenced Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants