Skip to content

docs: restructure how-to and tutorial pages#1564

Open
shree-iyengar-dls wants to merge 2 commits into
mainfrom
1468_restructure_blueapi_docs
Open

docs: restructure how-to and tutorial pages#1564
shree-iyengar-dls wants to merge 2 commits into
mainfrom
1468_restructure_blueapi_docs

Conversation

@shree-iyengar-dls

Copy link
Copy Markdown
Contributor

Fixes #1468

Changes made:

  • Run Auth locally page moved to How-to Guides
  • Run/Debug in a Developer Environment moves to How-to Guides
  • Run in a Container moved to Tutorials
  • Enable Persistent Volumes moved to Tutorials
  • Integrate With Numtracker moved to Tutorials

@shree-iyengar-dls shree-iyengar-dls requested a review from a team as a code owner June 25, 2026 10:28
@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.91%. Comparing base (50fd3dd) to head (7145c06).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1564   +/-   ##
=======================================
  Coverage   95.90%   95.91%           
=======================================
  Files          44       44           
  Lines        3250     3255    +5     
=======================================
+ Hits         3117     3122    +5     
  Misses        133      133           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@abbiemery

Copy link
Copy Markdown
Contributor

I have added some dodal agnostic devices and plans that can be used for the tutorials. See #1577.

There will also need to be a change to the message bus page as it currently uses the docker compose command for the system tests, which people who do pip install blueapi will not have. This command should work:

echo "[rabbitmq_stomp].">enabled_plugins && podman run -it --rm --name rabbitmq-docs -v $(readlink -f enabled_plugins):/etc/rabbitmq/enabled_plugins:z -p 5672:5672 -p 61613:61613 rabbitmq:latest

Rest of the review to follow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure documentation to make user and developer how-to's clearer.

2 participants