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

Use mdoc to provide safe documentation #294

Open
gaeljw opened this issue May 28, 2022 · 0 comments
Open

Use mdoc to provide safe documentation #294

gaeljw opened this issue May 28, 2022 · 0 comments
Assignees
Labels
πŸ“– documentation Improvements or additions to documentation good first issue Good for newcomers πŸ”§ build Related to build / release process

Comments

@gaeljw
Copy link
Member

gaeljw commented May 28, 2022

πŸ€” 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

@gaeljw gaeljw added πŸ”§ build Related to build / release process πŸ“– documentation Improvements or additions to documentation labels May 28, 2022
@gaeljw gaeljw added this to the 8.4 milestone May 28, 2022
@gaeljw gaeljw self-assigned this May 28, 2022
@gaeljw gaeljw removed this from the 8.4 milestone May 28, 2022
@gaeljw gaeljw added the good first issue Good for newcomers label May 28, 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 good first issue Good for newcomers πŸ”§ build Related to build / release process
Projects
None yet
Development

No branches or pull requests

1 participant