Skip to content

docs: restructure how-to and tutorial pages #1564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shree-iyengar-dls wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: restructure how-to and tutorial pages #1564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c82b8c
docs: restructure how-to and tutorial pages
shree-iyengar-dls Jun 25, 2026
7145c06
docs: change relative paths for cross-referencing
shree-iyengar-dls Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/tutorials/local-auth.md → docs/how-to/local-auth.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/tutorials/run-with-dev.md → docs/how-to/run-with-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Ensure you are inside your virtual environment:
source venv/bin/activate
```

You will need to follow the instructions for setting up RabbitMQ as in [instructions for setting up RabbitMQ](run-bus.md).
You will need to follow the instructions for setting up RabbitMQ as in [instructions for setting up RabbitMQ](../tutorials/run-bus.md).

The worker will be available from the command line (`blueapi serve`), but can be started from vscode with additional
debugging capabilities.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/write-devices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ The return type annotation `-> MyTypeOfDetector` is required as blueapi uses it
The device is created via a function rather than a global to preserve side-effect-free imports. Each device must have its own factory function.

:::{seealso}
[Numtracker integration](./integrate-with-numtracker.md) for how to configure where detectors write files.
[Numtracker integration](../tutorials/integrate-with-numtracker.md) for how to configure where detectors write files.
:::
2 changes: 1 addition & 1 deletion docs/how-to/integrate-with-numtracker.md → docs/tutorials/integrate-with-numtracker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

You will need to [get numtracker itself configured for your instrument](https://github.com/DiamondLightSource/numtracker/wiki/new_beamline).

Blueapi needs [valid authentication configured](./authenticate.md) to communicate with numtracker. It will propogate its auth token so both blueapi and numtracker should be aware of who the user is and that they have permission to be on the instrument sessions (visits) that are intended for use.
Blueapi needs [valid authentication configured](../how-to/authenticate.md) to communicate with numtracker. It will propogate its auth token so both blueapi and numtracker should be aware of who the user is and that they have permission to be on the instrument sessions (visits) that are intended for use.

## Configuration

Expand Down
0 docs/how-to/run-container.md → docs/tutorials/run-container.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/how-to/use-persistent-volumes.md → docs/tutorials/use-persistent-volumes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ BlueAPI can use persistent volumes as a scratch area. This allows the user to re
## Configuration

:::{seealso}
[Configure the Application](./configure-app.md)
[Configure the Application](../how-to/configure-app.md)
:::

The relevant configuration is below:
Expand Down
Loading