[Docs] Refine README and npmjs landing page#1508
Merged
minggangw merged 2 commits intoRobotWebTools:developfrom May 7, 2026
Merged
[Docs] Refine README and npmjs landing page#1508minggangw merged 2 commits intoRobotWebTools:developfrom
minggangw merged 2 commits intoRobotWebTools:developfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request refines the project’s primary documentation surfaces (repo README.md and the npm package landing page README) to better match the needs of ROS 2 developers and npm users, including surfacing rosocket and tightening installation/message-generation guidance.
Changes:
- Reorders and trims sections in
README.md, folding the API docs link into the Documentation section and promoting rosocket/TypeScript/message generation. - Syncs the npmjs landing page (
scripts/npmjs-readme.md) with the updated install/prebuilt/message-generation/TypeScript guidance and adds a concise rosocket section. - Updates/standardizes various phrasing (e.g., prebuilt binaries wording, license wording) and reorganizes example/demo links.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Reorganizes and trims the main README; promotes message generation/TypeScript/rosocket content and updates the documentation links/sections. |
| scripts/npmjs-readme.md | Aligns the npm landing page README with the repo README structure and adds a lightweight rosocket section and reordered example links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Use the generated types directly: | ||
|
|
||
| ```javascript | ||
| import * as rclnodejs from 'rclnodejs'; |
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.
Reorder, trim, and align the README and the npmjs landing page so they read cleanly for ROS 2 developers (repo) and web developers shopping on npmjs (package page).
README.md
##sections by ROS 2 developer priority: promoteROS 2 Interface Message Generation,Using rclnodejs with TypeScript, androsocketabove the demo sections; demoteElectron-based Visualizationandrclnodejs-cli.## API Documentationsection; fold the link into the Documentation TOC.docs.ros.orgreference links toen/lyrical/.scripts/npmjs-readme.md
Fix: #1458