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

Documentation improvements #58

Open
awesomebytes opened this issue Sep 10, 2024 · 0 comments
Open

Documentation improvements #58

awesomebytes opened this issue Sep 10, 2024 · 0 comments

Comments

@awesomebytes
Copy link
Contributor

Find in PR #57 some typo fixes, additionally, I would like to bring up some other parts of the documentation that, from a newcomer point of view, could use some love.

Note that while you may attempt to change any part of the configuration through this mean, not all of its properties are actually watched.
For example, while the storage plugin watches for any change in its configuration and will attempt to act on it, the REST plugin will only log a warning that it observed a change, but won’t apply it.
Changes to non-plugin parts of the configuration may be registered by the configuration, but not acted upon, such as the mode field of the configuration which is only ever read at startup.

Not really a typo, but I found this explanation pretty confusing. Maybe a list or diagram of "Watched properties and how they are acted upon changes" would help.

TODO: this part hasn’t been redocumented yet. Feel free to contact us on Discord to get more information.

Well, it's a TODO, just thought I'd bring it up.

[1] Off-topic: In https://zenoh.io/docs/getting-started/troubleshooting/ it says that: "Error treating timestamp for received Data" may appear if there is a discrepancy in between clocks of 100ms. When teaching ROS to students, specially in environments without access to the internet, just a local network, drifts in the clock were a relatively common issue. By using messages without a timestamp, we could overcome teaching the basics ignoring these kind of problems. Is there a way to ignore timestamps in zenoh? Or tune the discrepancy?

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

No branches or pull requests

2 participants