[Doc] Simplify README for npmjs - #1578
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR simplifies the npmjs-facing README (scripts/npmjs-readme.md) to present rclnodejs more concisely while still highlighting key capabilities and the recommended browser integration options.
Changes:
- Adds a compact “Key features” summary near the top of the README.
- Condenses the prebuilt-binaries section into a single paragraph with the
RCLNODEJS_FORCE_BUILD=1override. - Reworks the
rclnodejs/webbrowser section into a shorter, scannable bullet list (Typed SDK / transports / OpenAPI).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
coverage: 91.068%. remained the same — minggangw:fix-1577 into RobotWebTools:develop |
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
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.
This PR simplifies the npmjs-facing README (
scripts/npmjs-readme.md) to presentrclnodejsmore concisely while still highlighting key capabilities and the recommended browser integration options.Changes:
RCLNODEJS_FORCE_BUILD=1override.rclnodejs/webbrowser section into a shorter, scannable bullet list (Typed SDK / transports / OpenAPI).Fix: #1577