Skip to content

docs: add a ROS 2 usage guide - #43

Open
Amronos wants to merge 1 commit into
cursor/starlight-example-nav-8317from
cursor/ros2-guide-8317
Open

Amronos wants to merge 1 commit into
cursor/starlight-example-nav-8317from
cursor/ros2-guide-8317

Conversation

@Amronos

@Amronos Amronos commented Sep 2, 2026 •

Copy link
Copy Markdown
Member

What changed

Add a ROS 2 guide covering the rfdf_file parameter, transient-local publication, topic namespaces, and an example launch file. The existing README and specification now use the correct parameter name and tell subscribers to use the publisher's fully qualified topic.

This PR is based on #40. Merge #38 and #40 first, then retarget this PR to main.

Checks

  • bun --bun run astro check
  • bun --bun run build

RetriggerConfidence Score: 5/5

The PR appears safe to merge.

Summary

This PR adds a ROS 2 usage guide and corrects existing documentation for the publisher parameter and namespace-sensitive topic resolution.

  • Documents the rfdf_file parameter, transient-local QoS, message format, and an example launch file.
  • Adds the guide to the documentation navigation and landing page.
  • Aligns the README and specification introduction with the publisher's actual relative topic behavior.

Reviews (7) · Last reviewed commit: "docs: add a ROS 2 usage guide"

@vercel

vercel Bot commented Sep 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
rfdf Ready Ready Preview Sep 17, 2026 4:28am UTC

Comment thread docs/src/content/docs/guides/ros2.md Resolved
greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 2, 2026
@cursor
cursor Bot force-pushed the cursor/starlight-example-nav-8317 branch from db2a6d1 to 3359da9 Compare September 4, 2026 04:22
@cursor
cursor Bot force-pushed the cursor/ros2-guide-8317 branch from e910a53 to 5fe6478 Compare September 4, 2026 04:22
@greptile-apps
greptile-apps Bot dismissed their stale review September 4, 2026 04:22

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

Comment thread docs/src/content/docs/guides/ros2.md Resolved
greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 4, 2026
@cursor
cursor Bot force-pushed the cursor/starlight-example-nav-8317 branch from 3359da9 to f364058 Compare September 7, 2026 04:31
@cursor
cursor Bot force-pushed the cursor/ros2-guide-8317 branch from e0464a6 to 2877213 Compare September 7, 2026 04:31
@greptile-apps
greptile-apps Bot dismissed their stale review September 7, 2026 04:31

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 7, 2026
@Amronos
Amronos force-pushed the cursor/starlight-example-nav-8317 branch from f364058 to b4593f2 Compare September 15, 2026 07:11
@Amronos
Amronos force-pushed the cursor/ros2-guide-8317 branch from 2877213 to 7c11393 Compare September 15, 2026 07:11
@greptile-apps
greptile-apps Bot dismissed their stale review September 15, 2026 07:11

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 15, 2026
@Amronos Amronos changed the title feat(docs): add a ROS 2 guide and fix the publisher parameter name docs: add a ROS 2 usage guide Sep 15, 2026
Document the publisher parameter, transient-local topic, and launch setup. Fix the old parameter name and make topic resolution explicit throughout the existing docs.
@Amronos
Amronos force-pushed the cursor/starlight-example-nav-8317 branch from b4593f2 to fc04d4c Compare September 17, 2026 04:28
@Amronos
Amronos force-pushed the cursor/ros2-guide-8317 branch from 7c11393 to 9586db4 Compare September 17, 2026 04:28
@greptile-apps
greptile-apps Bot dismissed their stale review September 17, 2026 04:28

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

This branch was successfully deployed

1 active deployment
Preview — 9586db43 Deployed Sep 17, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants