RobotWebTools / rclnodejs / 25482305639

86%

push

github

[Docs] Refine README and npmjs landing page (#1508)

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

1567 of 1987 branches covered (78.86%)

Branch coverage included in aggregate %.

3183 of 3545 relevant lines covered (89.79%)

447.9 hits per line