search

typelevel / cats-effect

The pure asynchronous runtime for Scala
https://typelevel.org/cats-effect/
Apache License 2.0
2.04k stars 523 forks source link

Compile all documentation using mdoc #1846

Open gvolpe opened 3 years ago

gvolpe commented 3 years ago

In some places, you'll find docs using scala instead of scala mdoc. It should all be compiled by mdoc. E.g. monadcancel.

mr-git commented 3 years ago

There is something wrong with layout on MonadCancel, I tried to fix in my fork, but I didn't understand what causes the issue. image

gvolpe commented 3 years ago

@mr-git I already fixed that in https://github.com/typelevel/cats-effect/pull/1845 but the site needs to be published manually I think /cc @djspiewak

mr-git commented 3 years ago

not sure if this is the issue, but I do not see https://typelevel.org/cats-effect/docs/typeclasses/concurrent on left side menu under Typeclasses

mr-git commented 3 years ago

and https://typelevel.org/cats-effect/docs/schedulers is omitted from navigation at bottom of page - Thread Model navigates to Overview of Typeclasses, while both navigation buttons on bottom of Schedulers page navigate to same Overview of Typeclasses too

gvolpe commented 3 years ago

@mr-git the concurrent side-menu was fixed in https://github.com/typelevel/cats-effect/pull/1844

I see that the site has now been updated. The other issue seems legit, feel free to submit a PR :)

djspiewak commented 3 years ago

The site updates itself automatically btw, though any changes which take place in the md files on the main branch take about a day to propagate over.

And definitely some of the links need a little work!