Skip to content

Use mdoc to provide safe documentationΒ #294

Open
@gaeljw

Description

@gaeljw

πŸ€” What's the problem you've observed?

It's important to give accurate documentation to our users and sometimes documentation is not updated, leading to pieces of code copy/pasted by users from the documentation that don't work.

✨ Do you have a proposal for making it better?

Use mdoc which is quite standard in Scala ecosystem.

πŸ“š Any additional context?

N/A

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions