Repository navigation
[docs] Simplify and update project READMEs - #1698
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 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
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.
Fix: #1697