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

Make a microsite with organized docs #107

Open
armanbilge opened this issue Dec 18, 2021 · 0 comments
Open

Make a microsite with organized docs #107

armanbilge opened this issue Dec 18, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@armanbilge
Copy link
Member

Emphasis on organized, as we continue adding clouds that each need their own docs it's going to get complicated. Not entirely sure if we'll be able to use mdoc or will need mdoc.js for the Scala.js-only modules. It's a bit of a strange situation, since mdoc.js is intended for interactive browser-based Scala.js snippets, but we'll be compiling code targeting Node.js that won't run in the browser. So not quite sure if/how that would work.

Regarding site generator, I'm amenable to Laika, which I had a pleasant experience using for http4s-dom. Also the new docs generation capabilities in Scaladoc 3 seem interesting, see scalameta/mdoc#588 (comment).

@armanbilge armanbilge added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 18, 2021
@armanbilge armanbilge added this to the 0.1.0 milestone Dec 18, 2021
@armanbilge armanbilge removed this from the v0.1.0 milestone Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant