Skip to content

Update design documentation (backport #648) #654

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

Open
wants to merge 1 commit into
base: jazzy
Choose a base branch
from

Conversation

mergify[bot]
Copy link

@mergify mergify bot commented May 27, 2025

Description

Update and complete the design documentation in docs/design.md according to the developments made in the last few months.
The goal is also to give enough details for anyone to implement a rmw_zenoh compatible application directly using one of the Zenoh APIs (for instance zenoh-pico).


This is an automatic backport of pull request #648 done by [Mergify](https://mergify.com).

* Update intro and overview

* Update Router section

* Add section on keyexpr mapping

* Update Graph Cache section

* Update Context and Nodes sections

* Update Publishers and Subscriptions sections

* Update Service Clients and Service Servers sections

* Fix last references to Zenoh-c APIs

* Update QoS section

* README.md: add notes on interop with Zenoh and zenoh-plugin-ros2dds

* README.md: apply change suggestion

Co-authored-by: yadunund <[email protected]>
Signed-off-by: Julien Enoch <[email protected]>

* docs/design.md: apply changes suggestion

Co-authored-by: yadunund <[email protected]>
Signed-off-by: Julien Enoch <[email protected]>

* docs/design.md: apply changes suggestion

Co-authored-by: yadunund <[email protected]>
Signed-off-by: Julien Enoch <[email protected]>

---------

Signed-off-by: Julien Enoch <[email protected]>
Co-authored-by: yadunund <[email protected]>
(cherry picked from commit 5ea12c4)

# Conflicts:
#	README.md
Copy link
Author

mergify bot commented May 27, 2025

Cherry-pick of 5ea12c4 has failed:

On branch mergify/bp/jazzy/pr-648
Your branch is up to date with 'origin/jazzy'.

You are currently cherry-picking commit 5ea12c4.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/design.md

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   README.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

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

Successfully merging this pull request may close these issues.

2 participants