Improve Alarm Docs

[MrinallU]

Description

Adds more documentation on ROS alarms, including the logic surrounding their implementations as well as potential applications.

Screenshot or Video

Click on the deployment link.

Related Issues

- Closes #1040

Testing

This is documentation so no testing is required.

About This PR

• I have updated documentation related to this change so that future members are aware of the changes I've made.

[uf-mil-bot]

Hola, your friendly InvestiGator bot here with another message!

Because this PR was closed/merged, I'm going to remove the docs preview for now.

Have a great day! Go gators! 🐊

[cbrxyz]

Hi Mrinall! This is a good first attempt! The beginning and ends of this tutorial are great, and cover a great overview of why an alarm system has been implemented, and where someone can find more details about our specific implementation, ros_alarms.

Unfortunately, the documentation you write near the middle of the file is likely too unfocused for a ros_alarms introduction, as it focuses on general ROS services. You could consider moving some of your code into a separate tutorial about creating a ROS package with services and service files. However, inclusion of this material in documentation about a specific package like ros_alarms is too unfocused.

Apologies for the wait for a review, please make your corrections and submit when you have a chance, thank you!

[MrinallU]

Hi Mrinall! This is a good first attempt! The beginning and ends of this tutorial are great, and cover a great overview of why an alarm system has been implemented, and where someone can find more details about our specific implementation, ros_alarms.

Unfortunately, the documentation you write near the middle of the file is likely too unfocused for a ros_alarms introduction, as it focuses on general ROS services. You could consider moving some of your code into a separate tutorial about creating a ROS package with services and service files. However, inclusion of this material in documentation about a specific package like ros_alarms is too unfocused.

Apologies for the wait for a review, please make your corrections and submit when you have a chance, thank you!

Fixed! Thank you for the feedback!

[cbrxyz]

Thanks!