typelevel / typelevel/feral

Make a microsite with organized docs

Open
#107 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Scala
Stars
195
Forks
53
PR merge metrics
No merged PRs in 30d

Description

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 https://github.com/scalameta/mdoc/issues/588#issuecomment-993498312.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing mdoc, mdoc.js, Laika, and the Scaladoc 3 documentation capabilities mentioned in the issue, including whether Node.js-targeted Scala.js modules are supported. Define an organized microsite structure for the growing cloud-specific documentation and consider the work complete when that site can generate and present those docs consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.