Repository navigation
docs: explain pin-header mating-side aliases - #939
Open
zenoutlabs wants to merge 2 commits into
Open
zenoutlabs wants to merge 2 commits into
zenoutlabs wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The pin-header reference omits
connectsFromAboveandconnectsFromBelow, even though the props schema supports them. Document the two mating-side aliases, explicitlayerprecedence, 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:
git diff --checkpass. The format check runs before generated Docusaurus output is present, as in a clean checkout.tscircuit@0.0.2553/ CLI0.1.2255; emitted PCB components putJ_TOPontopandJ_BOTTOMonbottom. PCB and schematic images render. Its intentionally unconnected headers produce missing-trace warnings, plus the existing missing-sheet warning.J_TOPand mirrored bottom-sideJ_BOTTOMsilkscreen 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.