Skip to content

docs: document assembly.cable waypoint routing - #1048

Open
LBCron wants to merge 1 commit into
tscircuit:mainfrom
LBCron:docs/assembly-cable-waypoints-1046
Open

LBCron wants to merge 1 commit into
tscircuit:mainfrom
LBCron:docs/assembly-cable-waypoints-1046

Conversation

@LBCron

@LBCron LBCron commented Nov 16, 2026

Copy link
Copy Markdown

Fixes #1046

Summary

  • Add a 3D <assembly.cable /> waypoint routing example (assembly-cable-4.json and rendered preview PNG) demonstrating how to guide a 3-pin JST PH harness around a printed part (HOLDER) between two board connectors.
  • Document waypoints as ordered { x, y, z } offsets in millimetres, along with waypointAnchor ("start" | "end") and waypointAxisOrientation ("board_at_start" | "board_at_end"), noting that both are required when waypoints is provided and omitting waypoints (or passing []) preserves automatic routing.
  • Add waypoints, waypointAnchor, and waypointAxisOrientation to the cable properties table and remove the outdated sentence stating there are no route-hint props.

Validation

  • Regenerated preview data and 3D image with scripts/generate-assembly-previews.ts
  • bun run format:check
  • bunx tsc --noEmit
  • bun run build

@vercel

vercel Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
docs Ready Ready Preview Nov 16, 2026 10:50pm UTC

Request Review

@github-actions

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

@LBCron

LBCron commented Nov 19, 2026

Copy link
Copy Markdown
Author

Status check-in to keep this PR active — CI checks are green and the branch is mergeable against base. Happy to address any review feedback whenever convenient!

This branch was successfully deployed

1 active deployment
Preview — 9488b358 Deployed Nov 16, 2026 by vercel[bot]
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.

document assembly cable waypoint routing

1 participant