Expand hole docs for rect shape and solder mask props#694
Open
rushabhcodes wants to merge 2 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
rushabhcodes
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Expands the documentation for the <hole /> element to better match the @tscircuit/props surface area, including the new rect shape and additional sizing / solder-mask-related props, and updates the quickstart cheat sheet accordingly.
Changes:
- Documented a third hole shape (
rect) and added an example for rectangular holes. - Documented circle sizing via
radiusin addition todiameter, and added solder mask props (solderMaskMargin,coveredWithSolderMask). - Updated the quickstart “important props” list for
<hole />to reflect the expanded prop surface.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/intro/quickstart-ChatGPT.mdx | Updates the <hole /> quickstart bullet to list the expanded prop surface. |
| docs/elements/hole.mdx | Expands <hole /> docs with rect shape, radius, solder mask props, and new/updated examples and properties table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MustafaMulla29
approved these changes
Jun 1, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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
<hole />docs to match the sibling@tscircuit/propsAPI.recthole shape,radius, and solder-mask props to the docs page.<hole />points at the fuller prop surface.Validation
bun run buildwas attempted earlier, but the repo currently fails in generated Docusaurus debug files unrelated to this docs change.