Skip to content

Conversation

@Tom-Willemsen
Copy link
Member

@Tom-Willemsen Tom-Willemsen commented Nov 13, 2024

Expand tutorial documentation to walk through what plans & devices are, how to set/read/scan devices, how to execute a scan from the run engine, how to specify callbacks.

A lot of the "heavy lifting" should be done in lower-level documentation, the goal is to keep this page readable for a first-time bluesky user.

Closes #55

@rerpha rerpha self-requested a review November 14, 2024 07:45
@rerpha
Copy link
Contributor

rerpha commented Nov 14, 2024

Content looks good. There are a couple of MyST warnings about header levels in the overview page - need to change the (h3) headings ie. ### Plans to h2 ie. ## Plans

@Tom-Willemsen
Copy link
Member Author

Is there an option to fail build on myst warnings? looking...

@rerpha
Copy link
Contributor

rerpha commented Nov 14, 2024

sphinx-build -W --keep-going

@rerpha
Copy link
Contributor

rerpha commented Nov 14, 2024

@rerpha
Copy link
Contributor

rerpha commented Nov 14, 2024

will need #61 once that PR is merged

@rerpha rerpha merged commit 2914e3e into main Nov 14, 2024
11 checks passed
@rerpha rerpha deleted the tutorial branch November 14, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a "getting started" page

3 participants