docs: Add section for tutorial and docs to README

[matthewfeickert]

Description

Resolves #1782

Add a "User Guide" section as the very first section in the README that link to the pyhf tutorial. Also add badge to the Jupyter Book tutorial to the top of the README.

Checklist Before Requesting Reviewer

• Tests are passing
• "WIP" removed from the title of the pull request
• Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

• Summarize commit messages into a comprehensive review of the PR

* Add section to README that links to the pyhf tutorial.
   - c.f. https://pyhf.github.io/pyhf-tutorial/
* Add badge to the Jupyter Book tutorial to the top of the README.
* Add section to README that explicitly links to the documentation.
   - c.f. https://pyhf.readthedocs.io/

[matthewfeickert]

Relevant RTD build: https://pyhf--1789.org.readthedocs.build/en/1789/ so people can get a feel of the style.

[matthewfeickert]

I'm trying to sync language here

$ git grep 'in depth walkthrough'
.github/ISSUE_TEMPLATE/config.yml:    The pyhf tutorial is continually updated and provides an in depth walkthrough
README.rst:For an in depth walkthrough of usage of the latest release of ``pyhf`` visit the |pyhf tutorial|_.

but happy to change it.

[kratsg]

looks fine to me.

[codecov]

Codecov Report

Merging #1789 (55a3cb1) into master (2533bd9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1789   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files          64       64           
  Lines        4270     4270           
  Branches      683      683           
=======================================
  Hits         4190     4190           
  Misses         46       46           
  Partials       34       34           

Flag	Coverage Δ
contrib	26.25% <ø> (ø)
doctest	60.58% <ø> (ø)
unittests	96.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2533bd9...55a3cb1. Read the comment docs.

[alexander-held]

I was wondering whether it also makes sense to directly link the readthedocs here? The tutorial does so in the first line. It is also in the questions section in the readme as well as in the badges, but both of those are slightly more hidden compared to this new entry. A user will definitely find it regardless, but the benefit I see from also linking the RTD here is that they can be contrasted a bit so a user knows which website is more appropriate for their specific needs.

[matthewfeickert]

I think that's a good idea. I put it lower down so that a reader would be hit first by the user guide, then by examples, and then by the docs. Very happy for other thoughts here though. 👍

[alexander-held]

No strong opinion here, I think it is fine as-is. I personally think that the "What does it support" section is expert-level material, and that there is a lot of scrolling needed to get to the docs section, but ultimately it is just personal opinion. Users should be able to comfortably find what they are looking for with the layout implemented here.

[matthewfeickert]

I think I agree with you here. 👍 As that will take more thought then I think I have in me now, I've bumped that to Issue #1791.