diff --git a/docs/advanced/units.md b/docs/advanced/units.md index 028e50b..f506091 100644 --- a/docs/advanced/units.md +++ b/docs/advanced/units.md @@ -1,5 +1,6 @@ --- title: tscircuit Units +description: Understanding default units in tscircuit for length, electrical properties, and other measurements. --- In tscircuit you can specify a unit explicitly with a string e.g. "0.1mm", but diff --git a/docs/command-line/tsci-export.md b/docs/command-line/tsci-export.md index 580a39c..6101a9c 100644 --- a/docs/command-line/tsci-export.md +++ b/docs/command-line/tsci-export.md @@ -1,5 +1,6 @@ --- title: tsci export +description: Export tscircuit files to various formats including SVG schematics, PCB layouts, and fabrication files. --- import ImageWithCaption from "../../src/components/ImageWithCaption" diff --git a/docs/contributing/overview-of-projects.md b/docs/contributing/overview-of-projects.md index 877df76..c13af95 100644 --- a/docs/contributing/overview-of-projects.md +++ b/docs/contributing/overview-of-projects.md @@ -1,6 +1,7 @@ --- title: Overview of Projects sidebar_position: 2 +description: Explore the key tscircuit repositories including core libraries, tools, and web components that power the ecosystem. --- | Repo | Description | Open Issues | diff --git a/docs/contributing/the-contributor-handbook.md b/docs/contributing/the-contributor-handbook.md index c662c2c..60f9f4e 100644 --- a/docs/contributing/the-contributor-handbook.md +++ b/docs/contributing/the-contributor-handbook.md @@ -1,5 +1,6 @@ --- title: The Contributor Handbook +description: Essential patterns and guidelines for contributing to tscircuit, including development tools and coding standards. --- We have some important patterns that make contributing to diff --git a/docs/footprints/silkscreencircle.mdx b/docs/footprints/silkscreencircle.mdx index 4006b85..a91cc03 100644 --- a/docs/footprints/silkscreencircle.mdx +++ b/docs/footprints/silkscreencircle.mdx @@ -1,5 +1,6 @@ --- title: +description: Silkscreen circles are often used to indicate "pin1" on a chip. --- ## Overview diff --git a/docs/footprints/silkscreenrect.mdx b/docs/footprints/silkscreenrect.mdx index 509a989..04b0571 100644 --- a/docs/footprints/silkscreenrect.mdx +++ b/docs/footprints/silkscreenrect.mdx @@ -1,5 +1,6 @@ --- title: +description: Silkscreen rectangles can be used to encapsulate a rectangular area around a chip. --- ## Overview diff --git a/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx b/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx index 8ba184b..f299ef4 100644 --- a/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx +++ b/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx @@ -1,5 +1,6 @@ --- title: Building a Static Site +description: "`tsci build --site` packages your tscircuit project into a static website that anyone can browse without running a server." --- `tsci build --site` packages your tscircuit project into a static website that anyone can browse without running a server. The command evaluates your circuits, exports the generated assets into a `dist` folder, and wires them up to the tscircuit RunFrame viewer so visitors can flip between PCB, schematic, and 3D previews right in the browser. diff --git a/docs/intro/installation.md b/docs/intro/installation.md index 036bbcd..4417c53 100644 --- a/docs/intro/installation.md +++ b/docs/intro/installation.md @@ -1,6 +1,7 @@ --- title: Installation sidebar_position: 2 +description: Install tscircuit CLI globally or per-project to start building electronic circuits with TypeScript. --- ## Dependencies diff --git a/docs/tutorials/building-a-simple-usb-flashlight.mdx b/docs/tutorials/building-a-simple-usb-flashlight.mdx index 208b0f7..e5b0204 100644 --- a/docs/tutorials/building-a-simple-usb-flashlight.mdx +++ b/docs/tutorials/building-a-simple-usb-flashlight.mdx @@ -1,37 +1,38 @@ ---- -title: Building a Simple USB Flashlight ---- - -## Overview - -This tutorial will walk you through building a simple USB flashlight using -tscircuit. - -import TscircuitIframe from "@site/src/components/TscircuitIframe" - - { - const USBCPort = useUsbC("USBC") - const Button = usePushButton("SW1") - return ( - - - -