search

BCDA-APS / bluesky_training

Bluesky training, including instrument package
https://bcda-aps.github.io/bluesky_training/
Other
11 stars 0 forks source link

Make installation checklist and installation guide header consistent #283

Closed rodolakis closed 2 months ago

rodolakis commented 4 months ago

Some users were confused about the checklist at the top of the installation guide: should they follow checklist or the installation guide content? The wording of the TOC for the installation guide should be consistent with the working of the checklist, and ideally, the checklist link would link to the section from the installation guide (which can then refer to an external link). The checklist most likely has the correct order of operation, so we should make the guide match the checklist (not the other way around).

prjemian commented 2 months ago

It helps if the checklist uses rst anchors to reference the various steps. Sphinx will pull the exact text from each anchored section and use it in the checklist.

example

#. :ref:`instrument.create_bluesky_directory`

.. _instrument.create_bluesky_directory:

Create bluesky directory
------------------------

This makes an entry with text Create bluesky directory (which is linked to the anchor point).

prjemian commented 2 months ago

We discussed ...

Could move each section to its own file.