Skip to content

Add cylinder geometry type to obstacle docs#5062

Merged
btshrewsbury-viam merged 2 commits into
mainfrom
claude/add-cylinder-geometry-type
Jun 29, 2026
Merged

Add cylinder geometry type to obstacle docs#5062
btshrewsbury-viam merged 2 commits into
mainfrom
claude/add-cylinder-geometry-type

Conversation

@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Source changes

Docs changes

  • docs/motion-planning/obstacles/overview.md: Updated geometry types table from 5 to 6 types, added Cylinder row with config fields and usage guidance
  • docs/motion-planning/obstacles/configure-workspace-obstacles.md: Added "cylinder" to valid type values list in troubleshooting section; added cylinder to the method comparison table
  • docs/motion-planning/3d-scene/set-up-obstacle-avoidance.md: Added "cylinders" to the list of geometry types in the opening paragraph
  • docs/motion-planning/reference/kinematics.md: Added cylinder to the geometry field description for kinematic links

How I found these

  • Xref lookup: config-xref.md → geometry types in motion-planning section
  • Grep matches: grep -rn "cylinder|geometry.*type" found 4 files with relevant references to the geometry type enumeration

Generated by daily docs change agent


Generated by Claude Code

RDK now supports a "cylinder" geometry type for collision shapes.
Update the geometry types table, troubleshooting list, and prose
references across 4 pages.

Source: viamrobotics/rdk#6014
@netlify

netlify Bot commented May 16, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit ce29fa9
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a42a3988153420007c5634c
😎 Deploy Preview https://deploy-preview-5062--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 36 (🔴 down 7 from production)
Accessibility: 99 (🔴 down 1 from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (🔴 down 10 from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label May 16, 2026
@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

4 similar comments
@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

@btshrewsbury-viam btshrewsbury-viam self-assigned this Jun 25, 2026
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

Hold for merge — please don't merge this until the in-flight motion-planning and visualization PRs land first:

Both touch the same motion-planning / obstacle pages this PR edits, so merging cylinder first will cause conflicts, and the new pages those PRs add will also need the cylinder geometry type added. Once #5098 and #5099 are in, this PR should be rebased and the cylinder updates extended to the new/changed pages before merge.

Separately, a few additions are still needed here (cylinder is missing from three other config-level geometry lists, and there's an important config-only / mesh-cost caveat to add) — I'll fold those in during the rebase.

@btshrewsbury-viam btshrewsbury-viam changed the title Add cylinder geometry type to obstacle docs Add cylinder geometry type to obstacle docs [On Hold] Jun 26, 2026
@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

The frame-system geometry `Types` list omitted cylinder. Cylinder is a
valid config geometry type (spatialmath, rdk#6014), parallel to the
kinematics.md geometry field already updated in this PR.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdVfSBN5zBzSHStG1HoPDK
@btshrewsbury-viam btshrewsbury-viam changed the title Add cylinder geometry type to obstacle docs [On Hold] Add cylinder geometry type to obstacle docs Jun 29, 2026
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

Hold lifted. Confirmed this PR's four files are disjoint from the in-progress motion-planning rewrite (docs/motion-planning-pages touches frame-system/ and move-an-arm/ pages; this PR touches obstacles/, 3d-scene/, and reference/kinematics.md), so there's no merge conflict in either order.

Also added the one missing parallel reference: docs/reference/services/frame-system/_index.md geometry Types now includes cylinder, matching the kinematics.md edit.

All cylinder claims verified against rdk#6014 (type: "cylinder", config fields r/l, and the "arbitrarily flat / no minimum height-to-radius ratio" contrast vs. capsule's enforced l >= 2r). Ready to merge.

@btshrewsbury-viam btshrewsbury-viam merged commit 0dc0ea6 into main Jun 29, 2026
13 checks passed
@btshrewsbury-viam btshrewsbury-viam deleted the claude/add-cylinder-geometry-type branch June 29, 2026 16:59
@github-actions

Copy link
Copy Markdown

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants