docs(readme): trim to half length; surface 1.3.0 RCL + 2.0.0 wire removal - #175
Merged
Conversation
…oval The README had grown to 459 lines. Cut it to ~250 while making the release story explicit: - New 'Backends' section near the top consolidates the API-stability and deprecation notes: 1.3.0 lands the native RCL backend (Apple default-on, Linux via system ROS 2), and direct ZenohClient()/DDSClient() construction is deprecated and removed in 2.0.0. The umbrella API is unchanged. - Add a 1.3.0 row (bold) at the top of the release-history table. - Fold the OS-coverage market-share table into one sentence under Platforms. - Merge the publish/DDS/subscribe snippets into one Quick Start block; collapse Parameters/Actions/examples into a pointer paragraph. - Compress Features, Installation asides, Code generation, and the Roadmap. No content links removed; all relative links verified to resolve. Signed-off-by: Yutaka Kondo <yutaka.kondo@youtalk.jp>
Signed-off-by: Yutaka Kondo <yutaka.kondo@youtalk.jp>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Shortens
README.mdfrom 459 → 250 lines (~45% cut) and makes the release story explicit, as it had drifted behind the code.Why
The README was too long, and its release framing stopped at 1.2.0 — it never surfaced that 1.3.0 lands the native RCL backend or that the pure-Swift wire path is deprecated and removed in 2.0.0.
Changes
CRos2Jazzy/CRos2JazzyZenohxcframeworks) and Linux (system ROS 2).ZenohClient()/DDSClient()construction is deprecated → removed in 2.0.0; the umbrella API is unchanged and not deprecated.No documentation links were removed; all relative links verified to resolve.