Skip to content

[Docs] Refine README and npmjs landing page#1508

Merged
minggangw merged 2 commits intoRobotWebTools:developfrom
minggangw:fix-1458-14
May 7, 2026
Merged

[Docs] Refine README and npmjs landing page#1508
minggangw merged 2 commits intoRobotWebTools:developfrom
minggangw:fix-1458-14

Conversation

@minggangw
Copy link
Copy Markdown
Member

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

  • Reorder ## sections by ROS 2 developer priority: promote ROS 2 Interface Message Generation, Using rclnodejs with TypeScript, and rosocket above the demo sections; demote Electron-based Visualization and rclnodejs-cli.
  • Drop the standalone ## API Documentation section; fold the link into the Documentation TOC.
  • Add rosocket to the "Key features" line; refresh docs.ros.org reference links to en/lyrical/.
  • Trim filler across Installation, Quick Start, ROS 2 Interface Message Generation, TypeScript, Performance Benchmarks, rclnodejs-cli, and Electron-based Visualization (single demo, smaller screenshot).

scripts/npmjs-readme.md

  • Sync the same Install/Prebuilt/Message-Generation/TypeScript trims so the npm landing page stays consistent with the repo README.
  • Add a lean rosocket section between TypeScript and License.
  • Reorder "Documentation and Examples" bullets to surface rosocket above Electron.

Fix: #1458

Copilot AI review requested due to automatic review settings May 7, 2026 06:38
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Use the generated types directly:

```javascript
import * as rclnodejs from 'rclnodejs';
@coveralls
Copy link
Copy Markdown

coveralls commented May 7, 2026

Coverage Status

coverage: 85.864%. remained the same — minggangw:fix-1458-14 into RobotWebTools:develop

@minggangw minggangw merged commit 09b1f2d into RobotWebTools:develop May 7, 2026
29 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Roadmap: Prepare rclnodejs for ROS 2 Lyrical Luth

3 participants