Add or fix missing service docs #213
Conversation
| @@ -19,11 +19,13 @@ Catkit2 | |||
| :maxdepth: 1 | |||
| :caption: Built-In Services | |||
|
|
|||
| service/aimtti_plp | |||
| services/aimtti_plp | |||
There was a problem hiding this comment.
I think the name of the service is aimtti_plp_device
There was a problem hiding this comment.
You're right! However, the file that contains the service documentation is just called aimtti_plp (see here for all existing files containing service docs), and this is what we want to link to from the index.rst.
| @@ -19,11 +19,13 @@ Catkit2 | |||
| :maxdepth: 1 | |||
| :caption: Built-In Services | |||
|
|
|||
| service/aimtti_plp | |||
| services/aimtti_plp | |||
| services/allied_vision_camera | |||
| services/bmc_dm | |||
There was a problem hiding this comment.
I don't know if we have to add them, but every simulated service is not added, even though the camera_sim is included in the list
There was a problem hiding this comment.
Also true! We were initially not entirely sure whether we should include docs for the the simulated services here or not. Since a simulated service is supposed to have exactly the same behavior like a hardware service, minus all the setup that is required for a hardware service, I recently deleted all docs for simulated services in this list.
The reason the documentation for the simulated service camera_sim is still there because that one is somewhat special: it is a very general simulated service that can be used as the simulated service for any camera. So it seemed a good idea to give it its own doc page.
I admit these choices are somewhat arbitrary, but they are leaning on how we are currently using catkit2 and all its services. This might well be adjusted in the future
| @@ -19,11 +19,13 @@ Catkit2 | |||
| :maxdepth: 1 | |||
| :caption: Built-In Services | |||
|
|
|||
| service/aimtti_plp | |||
| services/aimtti_plp | |||
| services/allied_vision_camera | |||
| services/bmc_dm | |||
| services/camera_sim | |||
There was a problem hiding this comment.
The dummy_camera service is missing here too, I don't know is this is wanted or not
There was a problem hiding this comment.
Later the safety_manual_check is missing too
There was a problem hiding this comment.
True again! I have to admit I forgot what the dummy camera service is - it looks like a stand-in service for a camera that is simpler than camera_sim. Since I don't know of any active usage anywhere, or even a reason for it, I think it's ok to not add it for now. What are your thoughts?
There was a problem hiding this comment.
Yes, I think that if it is not used at all, it's okay not including it!
There was a problem hiding this comment.
As for the Safety Manual Check, good catch! I didn't find it because it doesn't even have a doc page yet. I added an empty one now and added it to the list of doc pages that need to be filled in, which we're treating in issue #190.
ivalaginja
force-pushed
the
feature/doclist
branch
from
d154c25 to
375f917
Compare
I found a bunch of typos and missing services in this list, this PR fixes them.