More effect DSL examples in docs

[johanandren]

This might be a consequence of me not being familiar enough with rust but I found it hard to understand the various composed effect factory names. When looking at for example warp they have a section on their dsl in the doc start page: https://docs.rs/warp/latest/warp/#filters and then also on individual function pages https://docs.rs/warp/latest/warp/filters/path/index.html

Would be nice if we could do something like that as well, on the landing page, the entity page or maybe the effect page and the individual concrete effect function pages.

[huntc]

I think a section in the API documentation on the effects would be useful, and so I'll do that.

That said, I think the major thing is to make sure that the commonly used effects are all conveniently discoverable from within your favourite code editor aka the and_then_ ones... and as said in #105, we should perhaps have then_ ones to compliment.

[huntc]

Are we able to resolve this issue now given the increased doc, and also, the discoverability of the combinators?

[johanandren]

I think it is better and maybe good enough. But I still think that if we could have small snippet showing off effect chains in those docs, like warp has it for their filters, that would be top notch though.

[huntc]

Okay dokey then