Polishing the hardware documentation

[josh146]

Context:

The existing hardware-focused documentation consists of two pages:

• The photonic hardware quickstart page. This is top level in the table of contents, and the purpose is to provide users a general and quick overview for using Strawberry Fields with photonic hardware. For more advanced or specific details, the user is instead directed to docstrings and tutorials.

• A tutorial on submitting jobs to a remote chip. This page is not top level, and is instead embedded on both the hardware quickstart page above, as well as the overall 'Tutorials' page. Its aim is to provide a reproducible walkthrough of submitting remote jobs.

However, there are a couple of issues with both pages:

• The quickstart does not provide any mention of remote job management (i.e., cancelling jobs).

• The tutorial is neither reproducible nor specific --- it contains a collection of loosely connected sections, and attempts to generalize to arbitrary photonic chips, rather than focusing purely on X8. Furthermore, by attempting to be generic, it becomes much more unmaintainable.

• Various typos.

Description of the Change:

• Have added a warning about API keys to the quickstart page, echoing the warning on the tutorial page (as requested by @co9olguy).

• The job management details are summarised on the photonic hardware quickstart page. This involved updating the docstrings in the job.py module.

• The tutorial has been lightly edited to (a) make it specific to the X8 chip, and (b) change the flow to be more reproducible and more closely match the existing tutorial structure.

Benefits:

• Tutorial is specific to the X8 chip, so is now more maintainable. No need to constantly update it as chip architectures change.

• The quickstart page does a better job summarising job management,.

• Several typos/incorrect code blocks were fixed.

Possible Drawbacks: n/a

Related GitHub Issues: n/a

[codecov[bot]]

Codecov Report

Merging #334 into master will decrease coverage by 0.00%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #334      +/-   ##
==========================================
- Coverage   97.69%   97.69%   -0.01%     
==========================================
  Files          51       51              
  Lines        6346     6345       -1     
==========================================
- Hits         6200     6199       -1     
  Misses        146      146              

Impacted Files	Coverage Δ
strawberryfields/api/job.py	93.02% <ø> (ø)
strawberryfields/circuitspecs/X12.py	100.00% <100.00%> (ø)
strawberryfields/circuitspecs/X8.py	100.00% <100.00%> (ø)
strawberryfields/circuitspecs/__init__.py	100.00% <100.00%> (ø)
strawberryfields/engine.py	94.55% <100.00%> (ø)
strawberryfields/api/connection.py	97.64% <0.00%> (-0.03%)	:arrow_down:

---

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 605819a...b263356. Read the comment docs.