docs: rename pcbkeepout → keepout (matches actual core element name) - #23
Open
gsdali wants to merge 1 commit into
Open
docs: rename pcbkeepout → keepout (matches actual core element name)#23gsdali wants to merge 1 commit into
gsdali wants to merge 1 commit into
Conversation
The element doc was filed under <pcbkeepout /> with the example showing <pcbkeepout shape="rect" .../> — but @tscircuit/core's element catalogue registers this component as Keepout, exposed via JSX as <keepout>. Trying to use <pcbkeepout> in actual circuit code fails the build with "Unsupported component type 'pcbkeepout'". Rename the doc and example to match the working JSX tag <keepout>. The PcbKeepoutProps type name in @tscircuit/props is unchanged (still PcbKeepoutProps); only the doc filename and the example tag need fixing. Also update the SKILL.md element catalog to point at the new path and re-sort it alphabetically. While here, document the <copperpour> outline prop with a worked example showing how to define an antenna keep-out by constraining the pour to a polygon. <keepout> and <copperpour outline=...> are the two canonical ways to exclude a region from copper fill; both should be discoverable from the docs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
The element doc was filed at
elements/pcbkeepout.mdwith the example showing<pcbkeepout shape="rect" .../>— but@tscircuit/core's element catalogue registers this component asKeepout, exposed via JSX as<keepout>. Trying to use<pcbkeepout>in actual circuit code fails the build:This is a pure docs mismatch — the runtime element exists and works correctly under the name
<keepout>(verified with a 5-line repro that produces apcb_keepoutrecord incircuit.json).Changes
elements/pcbkeepout.md→elements/keepout.md<pcbkeepout ...>→<keepout ...>in that fileSKILL.mdelement catalog:<pcbkeepout />→<keepout />, repositioned alphabetically (between<jumper>and<led>)<copperpour outline=...>as the alternative for "exclude pour fill from a region"outlineprop on<copperpour>with a worked example (antenna keep-out polygon) — same use case, different mechanismTest plan
<keepout shape="rect" pcbX={0} pcbY={0} width="6mm" height="4mm" />builds successfully and produces apcb_keepoutrecord incircuit.jsonpcbkeepoutremains in the skill repo:grep -r pcbkeepout .returns nothingSKILL.mdelement list is alphabetically sortedWhy
Hit while trying to add an antenna keep-out for an InsightSiP ISP3080-UX module. Followed the doc, used
<pcbkeepout>, build crashed. Wasted ~10 minutes diagnosing before greppingregister-catalogue.tsto find the actual export name. Renaming the doc + example will save the next person that time.The
PcbKeepoutPropstype name in@tscircuit/propsis unchanged — only the JSX tag and skill doc are affected.🤖 Generated with Claude Code