Skip to content

docs: explain pin-header mating-side aliases - #939

Open
zenoutlabs wants to merge 2 commits into
tscircuit:mainfrom
zenoutlabs:docs/pinheader-mating-side
Open

zenoutlabs wants to merge 2 commits into
tscircuit:mainfrom
zenoutlabs:docs/pinheader-mating-side

Conversation

@zenoutlabs

@zenoutlabs zenoutlabs commented Oct 8, 2026 •

Copy link
Copy Markdown

The pin-header reference omits connectsFromAbove and connectsFromBelow, even though the props schema supports them. Document the two mating-side aliases, explicit layer precedence, false values, and the error when both aliases are true. A runnable PCB comparison places one header on each side of the board and distinguishes board-side selection from footprint inversion.

Part of #849, track 8 only. This independently written update follows the unmerged documentation attempts in #854 and #874, using the current props schema and its existing tests as the source of truth.

Validation:

  • Documentation format check, typecheck, production build, and git diff --check pass. The format check runs before generated Docusaurus output is present, as in a clean checkout.
  • The exact new preview builds with tscircuit@0.0.2553 / CLI 0.1.2255; emitted PCB components put J_TOP on top and J_BOTTOM on bottom. PCB and schematic images render. Its intentionally unconnected headers produce missing-trace warnings, plus the existing missing-sheet warning.
  • Independent review checked the alias contract, explicit precedence, invalid combinations, and the exact preview against the generated circuit.
  • The hosted PCB renderer displays top-side J_TOP and mirrored bottom-side J_BOTTOM silkscreen from the exact example source. The comparison hides its 3D tab because the current CAD preview depicts both headers above the board despite the correct PCB layers. No CAD data or runtime behavior is changed.

Preview: pin-header reference. Verified the deployed page, the expanded PCB comparison with mirrored bottom-side silkscreen, and the hidden 3D tab.

Prepared with OpenAI Codex assistance and validated locally. No runtime or dependency changes.

@vercel

vercel Bot commented Oct 8, 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 Oct 8, 2026 7:17pm UTC

Request Review

Use the faithful PCB renderer and hide the misleading 3D view for this comparison. Exact source, hosted PCB layers, local build/type/format checks and independent review verified.

This branch was successfully deployed

1 active deployment
Preview — 38a78738 Deployed Oct 8, 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.

1 participant