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

Check README.md snippets with mdoc #7

Open
keynmol opened this issue Oct 24, 2024 · 0 comments
Open

Check README.md snippets with mdoc #7

keynmol opened this issue Oct 24, 2024 · 0 comments

Comments

@keynmol
Copy link

keynmol commented Oct 24, 2024

  1. Set up a docs project with mdoc enabled, e.g. https://github.com/indoorvivants/roach/blob/main/build.sbt#L89
  2. convert all snippets from scala to scala mdoc, make sure they compile (see 3)
  3. Add a command alias to check README: https://github.com/indoorvivants/roach/blob/main/build.sbt#L131
  4. Add it to CI
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@keynmol