From 6c82b8c5425b8e1881362284b2b2f16b6e2c85e0 Mon Sep 17 00:00:00 2001 From: root Date: Thu, 25 Jun 2026 10:24:15 +0000 Subject: [PATCH 1/2] docs: restructure how-to and tutorial pages --- docs/{tutorials => how-to}/local-auth.md | 0 docs/{tutorials => how-to}/run-with-dev.md | 0 docs/{how-to => tutorials}/integrate-with-numtracker.md | 0 docs/{how-to => tutorials}/run-container.md | 0 docs/{how-to => tutorials}/use-persistent-volumes.md | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename docs/{tutorials => how-to}/local-auth.md (100%) rename docs/{tutorials => how-to}/run-with-dev.md (100%) rename docs/{how-to => tutorials}/integrate-with-numtracker.md (100%) rename docs/{how-to => tutorials}/run-container.md (100%) rename docs/{how-to => tutorials}/use-persistent-volumes.md (100%) diff --git a/docs/tutorials/local-auth.md b/docs/how-to/local-auth.md similarity index 100% rename from docs/tutorials/local-auth.md rename to docs/how-to/local-auth.md diff --git a/docs/tutorials/run-with-dev.md b/docs/how-to/run-with-dev.md similarity index 100% rename from docs/tutorials/run-with-dev.md rename to docs/how-to/run-with-dev.md diff --git a/docs/how-to/integrate-with-numtracker.md b/docs/tutorials/integrate-with-numtracker.md similarity index 100% rename from docs/how-to/integrate-with-numtracker.md rename to docs/tutorials/integrate-with-numtracker.md diff --git a/docs/how-to/run-container.md b/docs/tutorials/run-container.md similarity index 100% rename from docs/how-to/run-container.md rename to docs/tutorials/run-container.md diff --git a/docs/how-to/use-persistent-volumes.md b/docs/tutorials/use-persistent-volumes.md similarity index 100% rename from docs/how-to/use-persistent-volumes.md rename to docs/tutorials/use-persistent-volumes.md From 7145c06cfb2a4827eefa8185b93b232696998ca4 Mon Sep 17 00:00:00 2001 From: root Date: Thu, 25 Jun 2026 15:40:12 +0000 Subject: [PATCH 2/2] docs: change relative paths for cross-referencing --- docs/how-to/run-with-dev.md | 2 +- docs/how-to/write-devices.md | 2 +- docs/tutorials/integrate-with-numtracker.md | 2 +- docs/tutorials/use-persistent-volumes.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to/run-with-dev.md b/docs/how-to/run-with-dev.md index 60024caab5..028f2e61d7 100644 --- a/docs/how-to/run-with-dev.md +++ b/docs/how-to/run-with-dev.md @@ -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. diff --git a/docs/how-to/write-devices.md b/docs/how-to/write-devices.md index 4fc1b8b949..5296731e25 100644 --- a/docs/how-to/write-devices.md +++ b/docs/how-to/write-devices.md @@ -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. ::: diff --git a/docs/tutorials/integrate-with-numtracker.md b/docs/tutorials/integrate-with-numtracker.md index d52bd21747..08f6d03023 100644 --- a/docs/tutorials/integrate-with-numtracker.md +++ b/docs/tutorials/integrate-with-numtracker.md @@ -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 diff --git a/docs/tutorials/use-persistent-volumes.md b/docs/tutorials/use-persistent-volumes.md index 993307585d..73b28d2382 100644 --- a/docs/tutorials/use-persistent-volumes.md +++ b/docs/tutorials/use-persistent-volumes.md @@ -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: