Skip to content
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: Docs for release #36

Merged
merged 2 commits into from
May 16, 2024

Conversation

RaulTrombin
Copy link
Member

Copy link

@ES-Alexander ES-Alexander left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggested content changes :-)

The main fundamental difference is emphasising that the library implements a protocol for device types, not specific devices - i.e. there can be multiple different devices that fit within / make use of the message set for a particular device type (e.g. Ping and Ping2 are both Ping1D type devices).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@RaulTrombin
Copy link
Member Author

Some suggested content changes :-)

The main fundamental difference is emphasising that the library implements a protocol for device types, not specific devices - i.e. there can be multiple different devices that fit within / make use of the message set for a particular device type (e.g. Ping and Ping2 are both Ping1D type devices).

Thks @ES-Alexander, I really appreciate the suggestions. Now it's easier to navigate the documentation and their related devices.


## Using example:
[SONARs](https://en.wikipedia.org/wiki/Sonar), or **So**und **N**avigation **A**nd **R**anging devices, transmit sound waves and measure their reflections to detect surrounding obstacles and objects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would probably be [SoNARs]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually only the first letter is capitalized. But no hard feelings. Once @ES-Alexander approves it we can merge.

@patrickelectric patrickelectric merged commit 7e9a396 into bluerobotics:master May 16, 2024
3 checks passed
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.

3 participants