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.

Sign up for GitHub

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

Jump to bottom

Create a documentation website #382

Open
satabin opened this issue Oct 12, 2023 · 0 comments
Open

Create a documentation website #382

satabin opened this issue Oct 12, 2023 · 0 comments
Assignees
@satabin

Comments

@satabin
Copy link
Member

satabin commented Oct 12, 2023

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.
@satabin satabin self-assigned this Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@satabin satabin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@satabin