Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
486 commits
Select commit Hold shift + click to select a range
2fc4b2f
cad assembly example (#201)
seveibar Oct 10, 2025
31b7625
Fix the Copy page markdown generation by using the turndown package a…
MustafaMulla29 Oct 10, 2025
010b251
wip local file import ex (#205)
seveibar Oct 10, 2025
e64ab0a
simplify import example, give example using projectBaseUrl for Circui…
seveibar Oct 10, 2025
449f306
add the doc for the tsconfig path resolution (#209)
imrishabh18 Oct 10, 2025
b8bbc11
fix cad model doc (#212)
seveibar Oct 10, 2025
a22f56a
Fix CircuitPreview projectBaseUrl (again), refactor CircuitPreview, a…
seveibar Oct 11, 2025
ce1a536
Adjust level 3 sidebar link padding (#215)
seveibar Oct 11, 2025
574d109
Fix level 3 sidebar hover indentation (#217)
seveibar Oct 11, 2025
bdb6156
Revamp Index/Overview Page of Docs (#214)
Ayushjhawar8 Oct 11, 2025
0e42f98
improve group positioning docs (#221)
seveibar Oct 11, 2025
18b2efd
fix: prevent sidebar padding changes on hover/active states (#220)
Asymtode712 Oct 11, 2025
75d02b1
Fix markdown format , Add missing or incomplete description, Add spac…
Ayushjhawar8 Oct 11, 2025
fff5af3
Update intro flashlight example (#225)
seveibar Oct 11, 2025
d9e3e1c
Document board anchor properties (#228)
Abse2001 Oct 11, 2025
2b323e1
add the docs for the <symbol> (#227)
imrishabh18 Oct 12, 2025
43011bd
add doc for tscircuit.config.json (#230)
imrishabh18 Oct 12, 2025
82b8485
Update installation instructions for tscircuit CLI (#232)
devroy10 Oct 12, 2025
54ab8e4
Add instructions for adding dependencies to automerge pipeline (#235)
seveibar Oct 12, 2025
054f71d
improve overview page header position (#222)
Ayushjhawar8 Oct 13, 2025
c2042b5
Add color usage example for LED element (#239)
Abse2001 Oct 13, 2025
9385e53
add support for mainComponentPath (#243)
seveibar Oct 13, 2025
54f68c1
Document board border radius option (#245)
seveibar Oct 14, 2025
4e4f28c
docs: document group props (#246)
seveibar Oct 15, 2025
4ed7fc1
Reduce markdown table font size (#249)
seveibar Oct 15, 2025
750ebc9
Document <hole /> with pill shape and rotation (#244)
MustafaMulla29 Oct 15, 2025
20062e1
Update group element docs (#248)
seveibar Oct 15, 2025
4403dc4
docs: document chip obstructsWithinBounds behavior (#252)
seveibar Oct 15, 2025
31dcb4a
docs: refine includeBoardFiles documentation (#253)
seveibar Oct 15, 2025
eec9b28
Add tscircuit.com to dependency graph (#255)
seveibar Oct 16, 2025
d039a68
add doc for `pcbnotedimension` (#258)
imrishabh18 Oct 16, 2025
06a599c
Improve mobile sidebar view (#242)
Ayushjhawar8 Oct 16, 2025
d35470d
Fix the table layout in all devices (#256)
Ayushjhawar8 Oct 16, 2025
ebc503e
Clarify symbol prop description (#261)
seveibar Oct 16, 2025
b200479
add docs for pcb_note_* (#259)
imrishabh18 Oct 16, 2025
e6a984f
docs: clarify board layers usage (#263)
seveibar Oct 16, 2025
1fad7a0
Use simplified selectors in pcbPath example (#264)
seveibar Oct 16, 2025
9ead6a8
Document placing components on bottom layer (#265)
seveibar Oct 17, 2025
c9913eb
Document tsci build path filtering and images option (#267)
seveibar Oct 18, 2025
8e939e1
Fix the white space issue and improve the pill/markdown format code d…
Ayushjhawar8 Oct 18, 2025
359cd97
fix:polygon smtpad in 3D view is empty (#269)
Abse2001 Oct 20, 2025
0848f1f
Add TypeScript guide on using React Context (#272)
seveibar Oct 21, 2025
f760491
Add CircuitPreview example to React context guide (#273)
seveibar Oct 21, 2025
e5d4b5d
Remove memoization guidance from React context TypeScript guide (#274)
seveibar Oct 21, 2025
5748a2a
Add fabricationnoterect doc and silkscreen isFilled example (#275)
seveibar Oct 21, 2025
ff1cd2e
Fix 'tscircuit Essentials' category descriptions (#278)
pxlpal Oct 22, 2025
def1b70
Fix fabrication note rect not rendering (#279)
pxlpal Oct 22, 2025
7f31755
Add doc for corner_radius in smtpad (#281)
techmannih Oct 23, 2025
2f53e6a
Update pcbnotedimension docs for auto measurements (#283)
seveibar Oct 23, 2025
ba1b6c9
Add custom thickness example to trace documentation (#284)
seveibar Oct 23, 2025
4b015b5
Document color options for <pcbnoterect> (#294)
ShiboSoftwareDev Oct 25, 2025
60f5f39
docs: add cutout element page (#295)
seveibar Oct 25, 2025
24bca7e
Update cutout previews (#296)
seveibar Oct 25, 2025
4072b82
Rename x and y to pcbX and pcbY in via.mdx (#297)
raykholo Oct 25, 2025
7fdce35
feat: Add Document for Run frame JLCPCB Import (#292)
Ayushjhawar8 Oct 26, 2025
5ec650b
new model (#301)
ShiboSoftwareDev Oct 27, 2025
3e775e3
Ensure all pages have descriptions for proper rendering of generated-…
pxlpal Oct 27, 2025
a1425ac
Remove suggested video on youtube video links (#299)
Ayushjhawar8 Oct 28, 2025
5dbdeb1
fix: incorrect prop name for the silkscreenrect component (#302)
imrishabh18 Oct 28, 2025
476ef5a
Update JLCPCB guide example to name component (#305)
seveibar Oct 30, 2025
0037e89
Add biscuit board laser ablation essentials guide (#306)
seveibar Nov 2, 2025
6d7d2cc
fix: wrap CircuitPreview components in board tags for proper renderin…
rushabhcodes Nov 6, 2025
43518e3
First tscircuit scripting guide, how to programmatically get the circ…
seveibar Nov 7, 2025
3032e56
Fix: Improve sidebar indentation for nested documentation groups (#315)
Ayushjhawar8 Nov 8, 2025
b34d645
update docs (#316)
ShiboSoftwareDev Nov 10, 2025
c88b674
SPICE sim docs (#317)
ShiboSoftwareDev Nov 10, 2025
c2ea35d
Set CircuitPreview browser 3D view off by default (#318)
seveibar Nov 11, 2025
1ac0986
Fix hole element docs coordinates (#320)
seveibar Nov 11, 2025
1a701a1
Add showInfiniteProp (#321)
Ayushjhawar8 Nov 11, 2025
3a05f0b
Fix hole example PCB coordinates in documentation (#322)
rushabhcodes Nov 11, 2025
ccfcb6b
Add supplier part numbers to Diode1N4148WS (#324)
nailoo Nov 12, 2025
f4713e6
feat(docs): Add RC circuit example for SPICE simulation (#325)
ShiboSoftwareDev Nov 12, 2025
5a1ee46
refactor: Reorganize SPICE simulation documentation (#326)
ShiboSoftwareDev Nov 12, 2025
456162b
Add switch example for SPICE simulation (#328)
ShiboSoftwareDev Nov 13, 2025
7b00ca8
feat: Add vertical stack option for CircuitPreview (#329)
ShiboSoftwareDev Nov 13, 2025
94c4823
docs: add schematicDisabled to board prop table (#327)
seveibar Nov 13, 2025
a84f5f5
update runfrome inside the tscircuti.com repo (#330)
imrishabh18 Nov 14, 2025
a2621c8
fix add board tag to vai for rendering 3d and pcb view (#332)
t431w Nov 14, 2025
957e17d
feat(docs): add half-wave rectifier SPICE example (#333)
ShiboSoftwareDev Nov 14, 2025
7689652
fix add board tag to silkscreenrect for rendering 3d view (#331)
nailoo Nov 15, 2025
f6ec23b
fix add board tag to silkscreencircle for rendering 3d view (#334)
t431w Nov 15, 2025
5c13297
Fix infinite grid lines (#335)
Ayushjhawar8 Nov 15, 2025
4a82985
Update KiCad import guide (#336)
seveibar Nov 16, 2025
ca63450
Document gltf and glb tsci export formats (#341)
seveibar Nov 18, 2025
b30fc96
Document `tsci build --transpile` (#342)
seveibar Nov 18, 2025
71c4802
add the doc for using local packages in development with yalc (#340)
imrishabh18 Nov 18, 2025
2a285c1
fix add board tag to Inductor for rendering 3d view (#343)
nailoo Nov 18, 2025
f81cd5f
add the doc about using the bun link (#344)
imrishabh18 Nov 18, 2025
e323b81
hide 3d and pcb view for schematic components (#339)
techmannih Nov 19, 2025
9941c77
fix copy button overlapping title (#345)
ArnavK-09 Nov 20, 2025
fb2a5fe
Fix silkscreenLine for defaultView attribute in CircuitPreview (#346)
techmannih Nov 21, 2025
5f2168f
Update CircuitPreview example to include board wrapper for via compon…
rushabhcodes Nov 23, 2025
f22a64e
fix add board tag to chips for rendering 3d view (#349)
t431w Nov 23, 2025
a574540
docs: make schematic view default and disable PCB/3D view for symbols…
techmannih Nov 23, 2025
b881b8e
full-wave
ShiboSoftwareDev Nov 30, 2025
d930d3f
Revert "full-wave"
ShiboSoftwareDev Nov 30, 2025
a4dd93c
full-wave (#359)
ShiboSoftwareDev Nov 30, 2025
df4d991
Adjust pinrow rows description (#358)
seveibar Dec 1, 2025
1539771
Add circuit-json-to-gerber to dependency graph (#360)
seveibar Dec 1, 2025
21f929b
switch (#361)
ShiboSoftwareDev Dec 1, 2025
bea3ceb
Add a new doc for installing kicad-libraries (#362)
MustafaMulla29 Dec 4, 2025
aaa1189
remove comment (#364)
seveibar Dec 5, 2025
3ec5157
Add circuit-json-to-gltf <> runframe to auto update pipeline diagram …
Ayushjhawar8 Dec 5, 2025
52d6c02
Add footprint attribute to resistors in subcircuit (#368)
nailoo Dec 7, 2025
bb9a8cc
Power Converters SPICE subcategory (#369)
ShiboSoftwareDev Dec 7, 2025
5cb9eb9
Rename x and y to pcbX and pcbY in pinheader (#372)
nailoo Dec 7, 2025
f3c08bb
rc (#371)
ShiboSoftwareDev Dec 7, 2025
c9d964b
fix add board tag to Led for rendering 3d view (#373)
nailoo Dec 7, 2025
3e61294
docs: expand board properties and add detailed usage examples (#374)
rushabhcodes Dec 7, 2025
578e0b9
Fix typo in section title: "Offseting" to "Offsetting" in board docum…
Devesh36 Dec 8, 2025
9a6bb60
Add documentation for rendering translucent models in CAD components …
Ayushjhawar8 Dec 8, 2025
7a84ddb
fix add board tag to diode for rendering 3d view (#380)
nailoo Dec 13, 2025
4c82600
fix: correct typo "critial" to "critical" in resistor documentation (…
Devesh36 Dec 13, 2025
921631a
fix add board tag to Capacitor for rendering 3d view (#384)
nailoo Dec 13, 2025
d3be291
fix add board tag to Net for rendering 3d view (#385)
nailoo Dec 13, 2025
5acb0c3
fix: update coordinates for silkscreenline example in documentation (…
rushabhcodes Dec 13, 2025
2bcb2dd
fix: add Circuit JSON to KiCad flow in package dependency diagram (#387)
Ayushjhawar8 Dec 13, 2025
3111bb5
fix: add zOffsetFromSurface property to cadmodel documentation (#388)
rushabhcodes Dec 14, 2025
3ea398c
fix add board tag to Fuse for rendering 3d view (#390)
nailoo Dec 15, 2025
72b2aae
fix add board tag to Resistor for rendering 3d view (#392)
nailoo Dec 15, 2025
0bb431c
Add hideSchematicTab prop to CircuitPreview for Hole (#391)
nailoo Dec 15, 2025
00c2805
Add hideSchematicTab prop to CircuitPreview for silkscreenline (#393)
nailoo Dec 16, 2025
3567f39
refactor: switch to jsdelivr and simplify CDN URL fetching for circui…
rushabhcodes Dec 20, 2025
e1eeafb
Add a new doc for exporting kicad-library (#398)
MustafaMulla29 Dec 22, 2025
861b37e
Add hideSchematicTab prop to CircuitPreview (#401)
nailoo Dec 27, 2025
9749331
docs: document tscircuit config options (#402)
seveibar Dec 31, 2025
3dde5e6
Document global silkscreen text size adjustment (#403)
techmannih Jan 2, 2026
d5f817c
Fix the kicad-library doc (#406)
MustafaMulla29 Jan 13, 2026
cabeb94
Fixing ArduinoShield example (#404)
Sahil-Gupta584 Jan 15, 2026
ef3165c
Pi Hat Buzzer Tutorial (#407)
seveibar Jan 15, 2026
bc35c0d
feat: prevent flickering of copy btn (#411)
ArnavK-09 Jan 20, 2026
408459e
Add <schematicpath /> documentation and register it in symbol compone…
seveibar Jan 26, 2026
10567e8
docs: document all tscircuit config flags (#413)
seveibar Jan 26, 2026
5d60342
feat: add markdown source plugin (#415)
ArnavK-09 Jan 26, 2026
c381a50
Update the symbol page to have custom NPN transistor and other symbol…
MustafaMulla29 Jan 27, 2026
4b48de1
Fix: Add svgPath and strokeColor example for schematicpath (#417)
MustafaMulla29 Jan 27, 2026
dc98bf2
KiCad Metadata Properties documentation (#420)
seveibar Jan 30, 2026
dcb58db
kicad pin metadata added (#421)
seveibar Jan 30, 2026
096a2b8
Add panelization guide with panel/subpanel examples (#422)
ShiboSoftwareDev Jan 31, 2026
81e74bc
section on viewing symbol ports (#419)
seveibar Jan 31, 2026
572cc7a
Add making lab boards contributing page (#423)
seveibar Feb 1, 2026
68cf546
Update pinrow parameters and add additional configuration options (#424)
rushabhcodes Feb 1, 2026
f0a760c
Instructions for using KiCad PCM (#425)
seveibar Feb 2, 2026
10ae55d
Remove is_fatal note from ordering API errors (#427)
seveibar Feb 2, 2026
11aaead
Add documentation for SPICE simulation elements (#429)
ShiboSoftwareDev Feb 4, 2026
02b9279
Move silkscreenrect properties section (#430)
seveibar Feb 4, 2026
a275e50
Add Micro MELF and Mini MELF package descriptions and parameters (#426)
rushabhcodes Feb 5, 2026
85ec609
Add CircuitPreview for pcbSx footprint targeting (#431)
seveibar Feb 6, 2026
bb5315d
Move KiCad library export guide (#432)
seveibar Feb 6, 2026
9123477
Update pcbSx KiCad footprint (#433)
seveibar Feb 6, 2026
9c18534
disable schematic view for board element (#434)
nailoo Feb 7, 2026
2ca481c
fix add board tag to Pinheader for rendering 3d view (#435)
nailoo Feb 7, 2026
1066b10
New doc for using tscircuit PCM urls in kicad (#437)
MustafaMulla29 Feb 10, 2026
5a84061
Update tsci build doc to include all the options and update config do…
MustafaMulla29 Feb 10, 2026
84e2eb7
disable schematic view for silkscreentext element (#439)
nailoo Feb 10, 2026
47eab86
disable schematic view for silkscreenrect element (#440)
nailoo Feb 10, 2026
722e57b
Add SPICE guide links to analogsimulation docs (#441)
seveibar Feb 11, 2026
a64cda2
fixed inductor value in boost-converter example (#442)
ShiboSoftwareDev Feb 11, 2026
12af19f
Fix invalid JSX in lab board preview snippet (#443)
seveibar Feb 12, 2026
f74dc4f
docs: add relative positioning guide for calc-based pcb layout (#445)
seveibar Feb 13, 2026
bc24b88
Replace Biscuit Board Laser Ablation guide with Single Layer Jumper A…
seveibar Feb 13, 2026
0458a01
docs: remove tips section from relative positioning guide (#447)
seveibar Feb 13, 2026
e53dc2e
Add a section about how to get a bar at the top of a pinLabel (#448)
imrishabh18 Feb 13, 2026
c0503d7
docs: update calc guide identifiers to camelCase (#449)
seveibar Feb 13, 2026
b87cdc5
docs: add fiducial component documentation with overview and properti…
rushabhcodes Feb 15, 2026
0b83632
Doc for port element (#454)
MustafaMulla29 Feb 16, 2026
8312103
add allowOffBoard property to chip component documentation (#452)
Devesh36 Feb 16, 2026
bfed8b8
Document --kicad-project flag and kicadProjectEntrypointPath (#458)
MustafaMulla29 Feb 17, 2026
284bf42
Updated Documentation image for Assembly View (#460)
blowmuffin Feb 17, 2026
1aa43c5
local pico circuit for pinout example instead of importing it (#461)
ShiboSoftwareDev Feb 17, 2026
44341e4
docs: add TQFP footprint documentation with parameters and examples (…
rushabhcodes Feb 18, 2026
35408ba
docs: update chip component documentation to include links for proper…
Devesh36 Feb 18, 2026
2129707
Enable Dynamic Board Sizing in FootprintPreview to Prevent Component …
rushabhcodes Feb 19, 2026
afaa7d5
docs: move 'Translucent Models' section from cadmodel.mdx to chip.mdx…
techmannih Feb 19, 2026
7a084a5
add showAsTranslucentModel documentation to cadmodel (#462)
techmannih Feb 19, 2026
2badd6e
doc :updated image according to the newest version (#465)
blowmuffin Feb 19, 2026
1d25492
Add runframe command for circuitjson.com (#469)
ArnavK-09 Feb 20, 2026
d019c65
refactor: simplify USB flashlight tutorial by removing unused imports…
Devesh36 Feb 21, 2026
ab329dc
Add knockout text feature to silkscreentext documentation (#473)
nailoo Feb 22, 2026
e42f623
Document --kicad-library-name flag (#470)
ArnavK-09 Feb 23, 2026
29af30d
document package files list and download endpoints more extensively (…
seveibar Feb 26, 2026
b7eaba6
docs: remove bounty details from sponsorship page (#480)
seveibar Feb 26, 2026
e097ee3
add docs for schematictable (#477)
rushabhcodes Feb 27, 2026
dd804a6
docs: add missing tsci snapshot flags (#482)
seveibar Feb 28, 2026
00e3d83
docs: add package_builds/get API and log stream guidance (#489)
seveibar Mar 5, 2026
096d3d4
docs: add connector element documentation page (#492)
seveibar Mar 6, 2026
b3b810f
Add documentation pages for <courtyardcircle />, <courtyardrect />, a…
seveibar Mar 6, 2026
5c741ed
Add showCourtyards support to courtyard examples (#493)
seveibar Mar 6, 2026
60c0b94
docs: update courtyardoutline examples to use outline prop (#496)
seveibar Mar 9, 2026
7f3bd34
docs: remove unused courtyardoutline props (#499)
seveibar Mar 9, 2026
df32c44
docs: add kicadPcm visibility note to PCM URL guide (#500)
seveibar Mar 10, 2026
9718ab3
docs: add pcbPositionAnchor layout guidance (#501)
seveibar Mar 11, 2026
67f063d
Document per-build output layout and clarify image generation flags f…
AnasSarkiz Mar 11, 2026
b2e5720
docs: document tsci push --compress option (#503)
seveibar Mar 11, 2026
cf221f0
Incorrect mention of autoupdate `circuit-json-to-gltf` to `runframe` …
imrishabh18 Mar 12, 2026
e52f170
Document kicadFootprintStrings (#509)
MustafaMulla29 Mar 13, 2026
d384d09
Add guide for distributing tscircuit libraries (#510)
seveibar Mar 13, 2026
18ea926
docs: use RootCircuit import from tscircuit in guide (#508)
seveibar Mar 13, 2026
2e8fcf1
docs: document {NAME}, {REF}, and {REFERENCE} substitution in <symbol…
techmannih Mar 18, 2026
a2b8744
Document ignore DRC cli flags (#514)
ShiboSoftwareDev Mar 18, 2026
63c5618
feat: add and enhance documentation for various `tsci` command-line t…
rushabhcodes Mar 18, 2026
3973888
docs: Add Reference Designator (RefDes) documentation to <footprint /…
techmannih Mar 19, 2026
a3e1ede
Updated the CLI documentation for `tsci` in the `docs/intro/installat…
rushabhcodes Mar 19, 2026
a515e49
Document --download flag (#520)
MustafaMulla29 Mar 24, 2026
143fea8
Add @tscircui/checks to the dependency updates (#521)
MustafaMulla29 Mar 28, 2026
0d8b1f9
Document pcbSnapshotSettings object in config (#522)
MustafaMulla29 Mar 31, 2026
c1814f1
This PR updates the CLI docs to cover several `tsci` options that wer…
rushabhcodes Apr 1, 2026
cfc3f6c
docs: emphasize user-first contribution philosophy (#525)
seveibar Apr 4, 2026
aeda84b
docs: add documentation for the --json flag in tsci search command (#…
techmannih2 Apr 6, 2026
71ac851
docs: move electronics ideas suggestion into tip (#527)
seveibar Apr 6, 2026
5ea772b
docs(board): document autorouterEffortLevel prop (#528)
seveibar Apr 6, 2026
c43bd49
skill installation recommendation (#530)
seveibar Apr 10, 2026
9715142
Add working STEP cadmodel docs example with bundled SOIC-8 asset and …
AnasSarkiz Apr 10, 2026
d004278
add doc for no connect (#531)
mohan-bee Apr 18, 2026
daac48e
docs(elements): rename documentation for <copperpour /> element (#532)
rushabhcodes Apr 18, 2026
fbdd99b
Update export doc (#535)
mohan-bee Apr 23, 2026
a76893f
Update custom autorouter docs (#537)
seveibar Apr 27, 2026
98118c8
Update README to simplify introduction
seveibar Apr 28, 2026
0949f68
Update README to include GitHub link for tscircuit
seveibar Apr 28, 2026
3ac2fd6
Add editable CircuitPreview examples (#540)
seveibar Apr 28, 2026
30e5612
Add connector standard example (#542)
MustafaMulla29 May 1, 2026
b704722
Add coppertext element documentation with PCB examples and props refe…
rushabhcodes May 1, 2026
1f07c12
docs: add missing <board /> props from @tscircuit/props (#545)
rushabhcodes May 3, 2026
ba45766
Document group schematic box rendering (#541)
ShiboSoftwareDev May 6, 2026
d32b753
introduce autorouting phase (#549)
seveibar May 7, 2026
bcf93ed
More sine wave pattern for custom autorouter in autorouting phase exa…
seveibar May 7, 2026
a46adc3
Add soic8.step (#552)
MustafaMulla29 May 8, 2026
79d5e4b
Add local step file cadmodel example (#553)
MustafaMulla29 May 8, 2026
d5f4dcf
add schematic section (#573)
Sang-it May 11, 2026
2ade382
fix led matrix playground link (#556)
thisisharsh7 May 12, 2026
f444533
hide-pcb-only-schematic-tabs (#557)
thisisharsh7 May 12, 2026
2e0a9ff
Remove issue wheel contributor tip (#581)
seveibar May 12, 2026
0d713db
fix blank keyboard docs preview (#554)
thisisharsh7 May 13, 2026
c876d6f
Update lab board size details in documentation
seveibar May 15, 2026
5521c89
Add section about the .kicad_pcb file import (#622)
imrishabh18 May 19, 2026
fc19109
docs: add documentation for <opamp /> element with properties and usa…
rushabhcodes May 22, 2026
476a25a
Add JLCPCB footprint docs (#661)
techmannih May 27, 2026
578317a
Document QFP thermal pad footprint strings (#669)
rushabhcodes May 27, 2026
11d12e2
Document QFN thermal pad footprint strings (#671)
rushabhcodes May 27, 2026
3f27496
rewrite (#675)
ShiboSoftwareDev May 28, 2026
b45ab16
Document <drccheck/> element (#680)
MustafaMulla29 May 29, 2026
362f91a
document dashed outlines for schematic rectangles (#689)
rushabhcodes May 31, 2026
f91bd74
Expand hole docs for rect shape and solder mask props (#694)
rushabhcodes Jun 1, 2026
eb5988f
document spicemodel (#698)
ShiboSoftwareDev Jun 1, 2026
c61cc52
Improve breakout doc (#699)
MustafaMulla29 Jun 2, 2026
948ea06
docs: add ti parts engine usage example (#703)
seveibar Jun 4, 2026
d16612b
Add documentation for cornerRadius property in silkscreen rectangles …
rushabhcodes Jun 4, 2026
ef42c9b
change ti platform config to have a circuit preview
seveibar Jun 4, 2026
9532ce8
Improve platedhole shape variants (#705)
rushabhcodes Jun 4, 2026
d679fee
docs: add MicroMod connector guide
jddark62 Jun 5, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
26 changes: 26 additions & 0 deletions .github/workflows/bun-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
name: Build

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install dependencies
run: bun install

- name: Run build
run: bun run build
26 changes: 26 additions & 0 deletions .github/workflows/bun-formatcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
name: Format Check

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
format-check:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install dependencies
run: bun install

- name: Run format check
run: bun run format:check
26 changes: 26 additions & 0 deletions .github/workflows/bun-typecheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
name: Type Check

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
type-check:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- name: Install dependencies
run: bun i

- name: Run type check
run: bunx tsc --noEmit
29 changes: 29 additions & 0 deletions .github/workflows/stalebot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 'Close stale issues and PRs'
on:
schedule:
- cron: '30 1 * * *' # Runs at 1:30 AM UTC every day

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
# Issues config
stale-issue-message: 'This issue has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.'
close-issue-message: 'This issue was closed because it has been inactive for 14 days since being marked as stale.'
days-before-issue-stale: 60
days-before-issue-close: 14

# Pull request config
stale-pr-message: 'This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.'
close-pr-message: 'This PR was closed because it has been inactive for 1 day since being marked as stale.'
days-before-pr-stale: 2
days-before-pr-close: 1

# General config
exempt-issue-labels: 'pinned,security,help-wanted'
exempt-pr-labels: 'pinned,security,help-wanted'
stale-issue-label: 'no-issue-activity'
stale-pr-label: 'no-pr-activity'
operations-per-run: 100
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dependencies
/node_modules

package-lock.json
# Production
/build

Expand Down
41 changes: 41 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# tscircuit docs - Development Guidelines

- Use `bun` not `node`/`npx`/`npm`

## Commands

- **Start development server**: `bun run start`
- **Build site**: `bun run build`
- **Serve built site**: `bun run serve`
- **Type check**: `bun run typecheck`
- **Format code**: `bunx @biomejs/biome format --write .`
- **Lint code**: `bunx @biomejs/biome lint .`

## Code Style

- **Formatting**: Use Biome formatter with space indentation
- **Imports**: Use organized imports (auto-sortable by Biome)
- **JSX**: Use double quotes for JSX attributes
- **Semicolons**: Prefer to omit except when necessary
- **Naming**: Use kebab-case for filenames
- **Types**: TypeScript is used throughout, explicit "any" is allowed
- **Error handling**: Follow React/Docusaurus error boundary patterns
- **Markdown**: Follow standard Docusaurus MDX patterns

## Documentation Standards

- Keep documentation concise and example-focused
- Include working code examples where possible
- Use proper heading hierarchy (h1 → h2 → h3)
- Images should include descriptive alt text

## Testing tscircuit TSX Code

- To test tscircuit TSX code, create a new file in the `codetestingplayground`
directory and add the code you want to test, then run `tsci build <filename>.circuit.tsx`
- You may also want to generate snapshots via `tsci snapshot <filename>.circuit.tsx`
and inspect the results
- The autorouter and DRC often throws errors and this is expected since the
product is in early stages of development, use `tsci build --ignore-errors` to ignore
non-fatal errors
- Prefer `bunx` over `npx`
41 changes: 41 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# tscircuit docs - Development Guidelines

- Use `bun` not `node`/`npx`/`npm`

## Commands

- **Start development server**: `bun run start`
- **Build site**: `bun run build`
- **Serve built site**: `bun run serve`
- **Type check**: `bun run typecheck`
- **Format code**: `bunx @biomejs/biome format --write .`
- **Lint code**: `bunx @biomejs/biome lint .`

## Code Style

- **Formatting**: Use Biome formatter with space indentation
- **Imports**: Use organized imports (auto-sortable by Biome)
- **JSX**: Use double quotes for JSX attributes
- **Semicolons**: Prefer to omit except when necessary
- **Naming**: Use kebab-case for filenames
- **Types**: TypeScript is used throughout, explicit "any" is allowed
- **Error handling**: Follow React/Docusaurus error boundary patterns
- **Markdown**: Follow standard Docusaurus MDX patterns

## Documentation Standards

- Keep documentation concise and example-focused
- Include working code examples where possible
- Use proper heading hierarchy (h1 → h2 → h3)
- Images should include descriptive alt text

## Testing tscircuit TSX Code

- To test tscircuit TSX code, create a new file in the `codetestingplayground`
directory and add the code you want to test, then run `tsci build <filename>.circuit.tsx`
- You may also want to generate snapshots via `tsci snapshot <filename>.circuit.tsx`
and inspect the results
- The autorouter and DRC often throws errors and this is expected since the
product is in early stages of development, use `tsci build --ignore-errors` to ignore
non-fatal errors
- Prefer `bunx` over `npx`
42 changes: 2 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,3 @@
# Website
# [docs.tscircuit.com](https://docs.tscircuit.com)

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
The [tscircuit](https://github.com/tscircuit/tscircuit) docs
15 changes: 14 additions & 1 deletion biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,18 @@
"enabled": true,
"indentStyle": "space"
},
"css": {
"parser": {
"cssModules": true
}
},
"files": {
"ignore": ["cosmos-export", "dist", "package.json"]
"ignore": [
"cosmos-export",
"dist",
"package.json",
"!./codetestingplayground"
]
},
"javascript": {
"formatter": {
Expand All @@ -31,6 +41,9 @@
"complexity": {
"noForEach": "info"
},
"correctness": {
"useExhaustiveDependencies": "off"
},
"style": {
"noUnusedTemplateLiteral": "off",
"noUselessElse": "off",
Expand Down
Loading
Loading