Skip to content

Create a documentation website #382

Description

@satabin

Documentation has been a problem since the beginning with snippets in the README not being correct or not evolving with the code (see #381 as last exhibit).

We should create a small website, using mdoc for documentation, integrated using the sbt-typelevel-site plugin. This would ensure that snippets are correct and compiling with the latest version of the code.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions