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

Tut to mdoc #3595

Merged
merged 6 commits into from
Sep 11, 2020
Merged

Tut to mdoc #3595

merged 6 commits into from
Sep 11, 2020

Conversation

keynmol
Copy link
Contributor

@keynmol keynmol commented Sep 6, 2020

Closes #2927

Published from this branch: http://cats-mdoc-site.surge.sh/cats/

Apart from one example in validated.md I've replaced all the tut modifiers and placed necessary nest/reset modifiers.

I had to rename a few things to avoid restructuring the examples, because of conflicting method names, but there's very few examples where this needed to be done.

TODO:

  • Figure out the issue in validated.md
  • Confirm that generated website is the same
  • Remove references of tut from CONTRIBUTING.md
  • Figure out why compiled mdoc files end up twice in the site structure sigh

@keynmol keynmol marked this pull request as ready for review September 8, 2020 13:17
@keynmol keynmol mentioned this pull request Sep 8, 2020
Copy link
Member

@LukaJCB LukaJCB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for taking on this gargantuan task!

@LukaJCB LukaJCB merged commit d912ced into typelevel:master Sep 11, 2020
@keynmol keynmol deleted the tut-to-mdoc branch September 11, 2020 18:28
@travisbrown
Copy link
Contributor

Wow, this is really great. Thanks for slogging through it.

@larsrh larsrh added this to the 2.3 milestone Oct 31, 2020
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.

Migrate to mdoc
6 participants