Add docs url for all functions in Glossary page about cats HOT 8 OPEN

I guess we can add examples, but it can be convoluted, which is opposite to the purpose of this page which in turn to give an overview of all the type classes.

I think if we have examples in the java doc, for each function is enough. wdyt?

from cats.

I think if we have examples in the java doc, for each example is enough. wdyt?

good point! :)

from cats.

• We have to keep update the docs url with scala version and cats version.

We can use @VERSION@ mdoc variable to keep the Cats version in sync. What if we link to the Scala 3 docs, does that work for going straight to the function?

• CI failed at generating the site

Hmmm. I wonder if it helps to put the links at the bottom of the doc instead of inline.

Thanks for your work on this!!

from cats.

thanks!
The scala 3 docs version works 💯

I also tried @VERSION@ with hope that mdoc works, because the scala 3 docs url is much simpler than the scala 2 docs with a lot of [][][][] :D

from cats.

Thank you, that sounds good to me! I wonder if we should add an example of how to use it with syntax as well? Since it's a bit different than calling the method directly on the typeclass.

from cats.

I did add some link here https://github.com/lenguyenthanh/cats/blob/add-links-for-glossary-page/docs/nomenclature.md.

But there are few issues, I can see right away (and not sure how to fix):

• CI failed at generating the site: https://github.com/lenguyenthanh/cats/actions/runs/5258938812/jobs/9503832137#step:10:1036
• java docs urls don't open at the function location like this link. This can be really confused to the readers.
• We have to keep update the docs url with scala version and cats version.

from cats.

after switching to scala 3 docs url, everything passes: https://github.com/lenguyenthanh/cats/actions/runs/5259440112

But I can't build the site locally. Both docs/tlSitePreview and docs/tlSite shutdown the sbt after a lot of warning like this: https://gist.github.com/lenguyenthanh/df88115b7af5b974d0324c3c2a712df6

But they did generate md files in site/target/mdoc, and the generated files look correct.

from cats.

shutdown the sbt

ugh, that's scalameta/mdoc#613

so that means that there are errors that need to be fixed

https://gist.github.com/lenguyenthanh/df88115b7af5b974d0324c3c2a712df6#file-cats-txt-L234

probably this?

https://gist.github.com/lenguyenthanh/df88115b7af5b974d0324c3c2a712df6#file-cats-txt-L192-L199

from cats.