From 090712a0f8d9e36395462bbb3c25b6c20eaef731 Mon Sep 17 00:00:00 2001 From: seveibar Date: Thu, 1 Oct 2026 19:12:41 -0700 Subject: [PATCH 1/2] docs: remove obvious component warnings --- docs/elements/battery.mdx | 8 ++------ docs/elements/capacitor.mdx | 10 +++------- docs/elements/chip.mdx | 6 ++---- 3 files changed, 7 insertions(+), 17 deletions(-) diff --git a/docs/elements/battery.mdx b/docs/elements/battery.mdx index 5969ae7e..278246d1 100644 --- a/docs/elements/battery.mdx +++ b/docs/elements/battery.mdx @@ -5,12 +5,12 @@ description: >- A `` is a power source that provides electrical energy through electrochemical reactions. Batteries are essential components that supply power to electronic circuits and devices. They have a positive and negative - terminal and must be connected with correct polarity. + terminal. --- ## Overview -A `` is a power source that provides electrical energy through electrochemical reactions. Batteries are essential components that supply power to electronic circuits and devices. They have a positive and negative terminal and must be connected with correct polarity. +A `` is a power source that provides electrical energy through electrochemical reactions. Batteries are essential components that supply power to electronic circuits and devices. They have a positive and negative terminal. A battery element has two pins and is polarized, meaning it has a positive terminal (cathode) and a negative terminal (anode). The voltage and capacity of the battery determine how much power it can provide and for how long. @@ -41,10 +41,6 @@ A battery has the following pins and aliases: | pin1 | pos, positive, cathode | The positive terminal that provides current | | pin2 | neg, negative, anode | The negative terminal that completes the circuit | -:::warning -Batteries are polarized components! You must connect the positive and negative terminals correctly. Reversing polarity can damage your circuit or the battery itself. -::: - ## Specifications Batteries can be configured with these key properties: diff --git a/docs/elements/capacitor.mdx b/docs/elements/capacitor.mdx index 8b985942..607f1171 100644 --- a/docs/elements/capacitor.mdx +++ b/docs/elements/capacitor.mdx @@ -12,7 +12,7 @@ description: >- A `` stores electrical energy in an electric field. Capacitors are commonly used for filtering, energy storage, and timing circuits. Unlike resistors, capacitors can be polarized (like electrolytic capacitors) or non-polarized (like ceramic capacitors). -A capacitor element has two pins. Polarized capacitors must be placed with correct orientation to avoid damage. +A capacitor element has two pins. When specifying a capacitor, you'll need to provide a footprint string (like `0402` or `0805`) and capacitance value. Popular capacitor types and sizes can be found at [jlcsearch](https://jlcsearch.tscircuit.com/capacitors/list). @@ -42,12 +42,8 @@ A capacitor has the following pins and aliases: | Pin # | Aliases (Polarized) | Description | | ---------- | ------- | ----------- | -| pin1 | pos, anode, left | The positive terminal (required for polarized capacitors) | -| pin2 | neg, cathode, right | The negative terminal (must be connected properly for polarized caps) | - -:::warning -For polarized capacitors, you must connect the positive and negative pins correctly. Reversing polarity can cause capacitor failure or even explosion! -::: +| pin1 | pos, anode, left | The positive terminal | +| pin2 | neg, cathode, right | The negative terminal | ## Specifications diff --git a/docs/elements/chip.mdx b/docs/elements/chip.mdx index a9c95c9f..02c723bd 100644 --- a/docs/elements/chip.mdx +++ b/docs/elements/chip.mdx @@ -750,10 +750,8 @@ export const A555Timer = (props: ChipProps) => ( ) ``` -:::warning -Make sure to have `as const` when you're defining your `pinLabels`, if you're -missing this the types won't work! -::: +`as const` preserves the literal pin labels so `ChipProps` can +use them for type checking. You can also use the `sel` object to access the pins of a chip for traces! From 229a6c1d8e499d8236d0b7da26e135fb99217aa2 Mon Sep 17 00:00:00 2001 From: seveibar Date: Thu, 1 Oct 2026 19:15:36 -0700 Subject: [PATCH 2/2] docs: restore chip type-safety warning --- docs/elements/chip.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/elements/chip.mdx b/docs/elements/chip.mdx index 02c723bd..a9c95c9f 100644 --- a/docs/elements/chip.mdx +++ b/docs/elements/chip.mdx @@ -750,8 +750,10 @@ export const A555Timer = (props: ChipProps) => ( ) ``` -`as const` preserves the literal pin labels so `ChipProps` can -use them for type checking. +:::warning +Make sure to have `as const` when you're defining your `pinLabels`, if you're +missing this the types won't work! +::: You can also use the `sel` object to access the pins of a chip for traces!