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

Add initial mdoc support #30

Merged
merged 5 commits into from
Nov 5, 2020
Merged

Add initial mdoc support #30

merged 5 commits into from
Nov 5, 2020

Conversation

regadas
Copy link
Collaborator

@regadas regadas commented Nov 3, 2020

  • mdoc compile is tied to Compile / paradox.
  • README.md is now a symlink to index.md

@johnynek
Copy link
Collaborator

johnynek commented Nov 3, 2020

Thanks! We would need to also run mdoc in the CI no? or is it automatically done by doc? Did you very the CI fails if you break some code?

@zmccoy zmccoy linked an issue Nov 3, 2020 that may be closed by this pull request
@regadas
Copy link
Collaborator Author

regadas commented Nov 3, 2020

@johnynek I was trying to tie it to the compile task but it seems to be a little bit tricky... the easy way was to add docs/mdoc as one of the steps. CI should fail if code breaks.

We will need to limit the docs build to 2.12/2.13 though ... I'm seeing some issues with dotty.

@regadas
Copy link
Collaborator Author

regadas commented Nov 4, 2020

@johnynek added a separate step for docs ... ok tried ... I need to see how to include the setup steps.

@regadas regadas marked this pull request as ready for review November 4, 2020 01:02
@regadas regadas requested a review from johnynek November 4, 2020 21:17
@johnynek
Copy link
Collaborator

johnynek commented Nov 5, 2020

thanks @regadas ! I don't really know much about the sbt plugin we are using to generate the yml, but it seems like it is doing the right thing.

Thanks.

@johnynek johnynek merged commit 88409ef into typelevel:main Nov 5, 2020
@johnynek
Copy link
Collaborator

Related to #7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

set up mdoc
2 participants