Missing cats-effect backend dependency information in public documentation

[adamnfish]

The documentation website does not include instruction on how to include the cats-effect backend as a dependency. This is an extra hurdle for people that want to use sttp with cats-effect, especially as the artifact's name ("com.softwaremill.sttp.client4" %% "cats") might not be what someone would guess.

---

On the master branch, we do helpfully see the dependency information for the cats-effect backend:

https://github.com/softwaremill/sttp/blob/master/docs/backends/catseffect.md?plain=1#L14-L18

Specifically, the section that says:

Firstly, add the following dependency to your project:

"com.softwaremill.sttp.client4" %% "cats" % "@VERSION@"

However, on the internet it appears to be using the v3 tag, which does not include this section.

https://github.com/softwaremill/sttp/blob/v3/docs/backends/catseffect.md

I'll be happy to raise a Pull Request against the v3 branch, but thought it best to raise a PR first in case that's not the best way to get this fixed?

Thank you!

[adamw]

It was an easy fix so here it is: https://github.com/softwaremill/sttp/commit/c87511f92c88a03da96b12b31f7ecb2a03c6f386

Though it will be visible on the "stable" version of the docs after a release. So far it's here: https://sttp.softwaremill.com/en/v3/backends/catseffect.html

[adamnfish]

Thank you! Although now I'd observe that we've created a new documentation problem, which is that these v3 docs show the v4 library dependency. I think this should say client3?

[adamw]

🤦 yes of course - fixed