Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New user experience report for HTTP request libraries #113

Open
tomjaguarpaw opened this issue Feb 2, 2022 · 0 comments
Open

New user experience report for HTTP request libraries #113

tomjaguarpaw opened this issue Feb 2, 2022 · 0 comments
Assignees

Comments

@tomjaguarpaw
Copy link
Owner

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

@tomjaguarpaw tomjaguarpaw self-assigned this Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant