BCDA-APS / bluesky_training

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

DOC main `index.rst` file: "First Steps" points to cheat sheet #107

Closed prjemian closed 4 months ago

prjemian commented 1 year ago

On the main documentation page (https://bcda-aps.github.io/bluesky_training/), the link to the First Steps Guide points to the cheat sheet: https://bcda-aps.github.io/bluesky_training/howto/first_steps_guide.html

The _CommandReview goes through this cheat sheet. Perhaps this sequence of renames and edits:

sequence existing file existing title new file new title
1 howto/first_steps_guide First Steps with Bluesky reference/_cheat_sheet Bluesky Cheat Sheet
2 reference/_command_review Review of commands howto/first_steps_guide First Steps with Bluesky

In index.rst, change https://github.com/BCDA-APS/bluesky_training/blob/1ca47d91d43c6b06cd7b8367f57be26596efacfc/docs/source/index.rst?plain=1#L17

change (appends a new line) to

    First Steps to use Bluesky after installation.
    Uses the `Bluesky Cheat Sheet <https://bcda-aps.github.io/bluesky_training/reference/_cheat_sheet.html>`_.

Note: These repository files have links to howto/first_steps_guide:

These repository files have links to reference/_command_review:

prjemian commented 4 months ago

Since this issue was first created, the index.rst page has been changed. The proposed changes no longer apply.