Skip to content

[docs] Simplify and update project READMEs - #1698

Merged
minggangw merged 2 commits into
RobotWebTools:developfrom
minggangw:fix-1697
Nov 19, 2026
Merged

minggangw merged 2 commits into
RobotWebTools:developfrom
minggangw:fix-1697

Conversation

@minggangw

Copy link
Copy Markdown
Member
  • Use concise wording without manual prose wrapping.
  • Improve the main and npm README browser overviews and demo links.
  • Fix Rosocket setup, ES module examples, BigInt encoding, and availability notes.
  • Clarify source-build requirements, interface generation, and TypeScript imports.
  • Correct JSDoc CI guidance while preserving deployment warnings.
  • Explain benchmark timing limits without changing historical results.
  • Retain Web SDK transport, cleanup, and security caveats.

Fix: #1697

Copilot AI balanced review requested due to automatic review settings November 19, 2026 07:02

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain for the documentation-only updates to setup and usage guidance.

No open issues 🎉

What changed in this PR

This documentation-only PR simplifies the project READMEs and updates setup and usage guidance for rclnodejs and its browser integrations, addressing #1697.

Changes:

  • Streamlines the main and npm READMEs with clearer browser overviews and demo links.
  • Corrects Rosocket examples and clarifies interface generation, TypeScript usage, and Web SDK limitations.
  • Updates JSDoc workflow guidance and explains benchmark timing limits while preserving historical results.
File Description
web/​README.md Simplifies SDK guidance while retaining transport, cleanup, and security caveats.
tools/​jsdoc/​README.md Condenses documentation workflows and corrects CI guidance while preserving deployment warnings.
scripts/​npmjs-readme.md Updates npm-facing installation, interface generation, and browser examples.
rostsd_gen/​readme.md Clarifies TypeScript declaration generation commands.
rosocket/​README.md Updates installation, ES module examples, BigInt encoding, and access-control guidance.
README.md Streamlines the project overview, setup guidance, and browser demo links.
benchmark/​README.md Clarifies benchmark setup and timing scope without changing recorded results.

Review effort: Balanced

@coveralls

coveralls commented Nov 19, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 91.355%. remained the same — minggangw:fix-1697 into RobotWebTools:develop

@minggangw
minggangw merged commit e086b05 into RobotWebTools:develop Nov 19, 2026
16 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.

Simplify and correct project READMEs

3 participants