-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
update documentation #248
base: main
Are you sure you want to change the base?
update documentation #248
Conversation
Will also want to update lifecycle.rst |
Codecov Report
@@ Coverage Diff @@
## main #248 +/- ##
=======================================
Coverage 88.57% 88.57%
=======================================
Files 41 41
Lines 1339 1339
=======================================
Hits 1186 1186
Misses 153 153 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
publishing Bluesky event documents to the message bus. This object is injected as a dependency into | ||
(using the FastAPI_ dependency injection system) to all REST endpoints, exposing their methods to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
publishing Bluesky event documents to the message bus. This object is injected as a dependency into | |
(using the FastAPI_ dependency injection system) to all REST endpoints, exposing their methods to | |
publishing Bluesky event documents to the message bus. This object is injected as a dependency (using the FastAPI_ dependency injection system) into the REST endpoints, exposing their methods to |
@@ -37,10 +37,17 @@ the known expectations of the plan, passes it to the ``RunEngine`` and handles a | |||
The Service Object |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's now called handler but maybe should have a better name
------------------------- | ||
|
||
If you change any of the code in src/blueapi/service/main, it is imperative that | ||
you update the openapi schema to reflect these changes. There is a test to check |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add reason why
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
check how this shows up in dark mode
Use the command line interface (CLI) | ||
==================================== | ||
|
||
Blueapi comes pacakged with a simple click based CLI. You can start the server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
delete first sentence
|
||
Blueapi comes pacakged with a simple click based CLI. You can start the server | ||
and then query it for plans and devices, as well as ask it to run a plan, through | ||
the CLI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the CLI. | |
the bundled CLI client. |
and then query it for plans and devices, as well as ask it to run a plan, through | ||
the CLI. | ||
|
||
Starting the server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs merging with the out of date cli docs in main (https://diamondlightsource.github.io/blueapi/main/user/how-to/run-cli.html) an requires a link to https://diamondlightsource.github.io/blueapi/main/user/reference/cli.html
this is by definition out of date, petition to close @callumforrester |
@stan-dot would you mind reviewing it and making sure there is no useful information that's still relevant? If so you can close it. |
This repository has changed a bit and the docs need to be updated.