Skip to content

Commit 3f90607

Browse files
committed
docs(web): align package layout — move tutorials/web.md to web/README.md
Mirror the rosocket/ layout: rosocket/README.md is the package-shaped reference for the rosocket subpackage, so rclnodejs/web's user-facing guide should live at web/README.md too. Same content, just renamed (git tracks it as a rename, history preserved). - tutorials/web.md → web/README.md (292 lines, no content change beyond intro link) - README.md cross-refs updated (Get-started row + 'Browser ↔ ROS 2' bullet) - tutorials/README.md entry now points at ../web/README.md - web/README.md intro path adjusted from 'web/client.js' to './client.js' since the doc is now next to the source - See-also section in web/README.md drops 'web/client.js' → './client.js' This also gives npmjs.com/package/rclnodejs/web a real rendered landing page (npm renders subpath READMEs), matching what's been true for rosocket since 2.0.0-beta.0.
1 parent ac03aba commit 3f90607

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This example assumes your ROS 2 environment is already sourced.
3030
## Documentation
3131

3232
- Get started:
33-
[Installation](#installation), [Quick Start](#quick-start), [Web SDK guide](./tutorials/web.md), [Tutorials](./tutorials/)
33+
[Installation](#installation), [Quick Start](#quick-start), [Web SDK guide](./web/README.md), [Tutorials](./tutorials/)
3434
- Reference:
3535
[API Documentation](https://robotwebtools.github.io/rclnodejs/docs/index.html), [Using TypeScript](#using-rclnodejs-with-typescript), [ROS 2 Interface Message Generation](#ros-2-interface-message-generation)
3636
- Features:
@@ -115,7 +115,7 @@ More runnable examples in [example/](https://github.com/RobotWebTools/rclnodejs/
115115
`rclnodejs` ships **two** browser ↔ ROS 2 bridges — pick one based on
116116
how much glue you want to write.
117117

118-
- **[`rclnodejs/web`](./tutorials/web.md)****typed, allow-listed,
118+
- **[`rclnodejs/web`](./web/README.md)****typed, allow-listed,
119119
curl-able** browser ↔ ROS 2. A `web.json` file is your public API;
120120
the browser SDK types `call` / `publish` / `subscribe` end-to-end
121121
from rclnodejs's auto-generated message maps; and

tutorials/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Reduce network traffic and improve performance by filtering messages at the DDS
4242

4343
Use RxJS Observables for reactive programming with ROS 2 subscriptions. Apply operators like `throttleTime()`, `combineLatest()`, and `filter()` to process message streams declaratively.
4444

45-
#### [rclnodejs/web — Browser SDK guide](web.md)
45+
#### [rclnodejs/web — Browser SDK guide](../web/README.md)
4646

4747
Front-end developer guide to talking to ROS 2 from a web app using `rclnodejs/web` and the bundled `rclnodejs-web` CLI. Covers the `connect()` URL forms (WebSocket vs. HTTP vs. split endpoints), the typed verb API (`call` / `publish` / `subscribe`) with single-string-generic typing derived from generated `MessagesMap` / `ServicesMap`, the `"42n"` BigInt convention, structured error codes, and curl recipes.
4848

tutorials/web.md renamed to web/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> Talk to ROS 2 from a web app — typed, allow-listed, no `roslibjs`.
44
55
`rclnodejs/web` is the browser-side of `rclnodejs`: a compact ESM
6-
module (`web/client.js`) plus a server runtime (`bin/rclnodejs-web.js`)
6+
module (`./client.js`) plus a server runtime (`../bin/rclnodejs-web.js`)
77
that exposes a declarative subset of your ROS 2 graph over WebSocket
88
**and** plain HTTP. The browser API is three verbs — `call`,
99
`publish`, `subscribe` — typed end-to-end from rclnodejs's
@@ -282,7 +282,7 @@ narrow, declarative contract.
282282

283283
## See also
284284

285-
- [`web/client.js`](../web/client.js) — the SDK source, worth a skim.
285+
- [`client.js`](./client.js) — the SDK source, worth a skim.
286286
- [`demo/web/javascript/`](../demo/web/javascript/) — runnable demo,
287287
no build tools, transport toggle + curl recipes.
288288
- [`demo/web/typescript/`](../demo/web/typescript/) — same demo with

0 commit comments

Comments
 (0)