tomjaguarpaw / tilapia

Improving all Haskell's programmer interfaces

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

New user experience report for HTTP request libraries

tomjaguarpaw opened this issue · comments

I had good experience with docs providing different level of abstraction.

  1. On one hand a “quickstart” section to get a wide spektrum of standard “simple” things quickly done.
    Also useful for Users who already have experience in the topic
  2. Potentially a more “advanced” section showing more specialized features
  3. A section explaining the lib’s design, insights and recurrent pattern.
  4. the API
    and everything accompanied by examples
    for instance the python lib requests which has in my opinion a great doc
    Quickstart — Requests 2.27.1 documentation
    in comparison to what I found on haskell’s side to make requests.
    req → Network.HTTP.Req
    or http conduit

https://discourse.haskell.org/t/haskell-newbie-feeling-overwhelmed-by-haskells-modules-and-docs/3996/10