Ensure all pages have descriptions for proper rendering of generated-index page (#282)

pxlpal · web-flow · commit 8792ba932fba · 2025-10-27T20:23:48.000+01:00
diff --git a/docs/command-line/tsci-add.mdx b/docs/command-line/tsci-add.mdx
@@ -1,5 +1,6 @@
 ---
 title: tsci add
+description: Install tscircuit registry packages using the tsci add command
 ---
 
 `tsci add` is the same as `npm add` or `bun add`, but defaults to the tscircuit
@@ -27,4 +28,4 @@ export default () => (
 )
 
 `}
-/>
+/>
diff --git a/docs/command-line/tsci-auth-print-token.md b/docs/command-line/tsci-auth-print-token.md
@@ -1,5 +1,6 @@
 ---
 title: tsci auth print-token
+description: Print your current tscircuit API token for use with web services
 ---
 
 `tsci auth print-token` prints your current tscircuit API token. This token can be used with the advanced web APIs such as the [Datasheet API](../web-apis/datasheet-api.md).
diff --git a/docs/command-line/tsci-dev.md b/docs/command-line/tsci-dev.md
@@ -1,5 +1,6 @@
 ---
 title: tsci dev
+description: Run a local preview server for your tscircuit project
 sidebar_position: 2
 ---
 
diff --git a/docs/command-line/tsci-login.md b/docs/command-line/tsci-login.md
@@ -1,5 +1,6 @@
 ---
 title: tsci login
+description: Sign in to the tscircuit registry to enable publishing and cloud tools
 sidebar_position: 1
 ---
 
diff --git a/docs/command-line/tsci-search.md b/docs/command-line/tsci-search.md
@@ -1,5 +1,6 @@
 ---
 title: tsci search
+description: Discover footprints and packages across the tscircuit ecosystem
 ---
 
 `tsci search` finds footprints and packages from across the tscircuit ecosystem.
diff --git a/docs/contributing/bounties-and-sponsorship.md b/docs/contributing/bounties-and-sponsorship.md
@@ -1,5 +1,6 @@
 ---
 title: Bounties and Sponsorship
+description: Understand how tscircuit bounties and contributor sponsorships are awarded
 ---
 
 tscircuit has thousands of dollars (USD) of bounties opened every month in over
diff --git a/docs/contributing/getting-started-as-a-contributor.md b/docs/contributing/getting-started-as-a-contributor.md
@@ -1,5 +1,6 @@
 ---
 title: Getting Started as a Contributor
+description: Learn how to set up your environment and find issues in the tscircuit ecosystem
 sidebar_position: 1
 ---
 
diff --git a/docs/footprints/footprint-elements-vs-footprint-strings.mdx b/docs/footprints/footprint-elements-vs-footprint-strings.mdx
@@ -1,5 +1,6 @@
 ---
 title: Footprint Elements vs Strings
+description: Compare using footprint elements and footprinter strings when defining components
 sidebar_position: 1
 ---
 
@@ -33,4 +34,4 @@ import CircuitPreview from "@site/src/components/CircuitPreview"
       } pcbX={3} resistance="1k" />
     </group>
   )
-`} />
+`} />
diff --git a/docs/guides/running-tscircuit/connecting-to-github.mdx b/docs/guides/running-tscircuit/connecting-to-github.mdx
@@ -1,5 +1,6 @@
 ---
 title: Connect GitHub Repositories to tscircuit
+description: Link your project repo to tscircuit for automatic previews and publishing
 ---
 
 You can connect your GitHub repositories to tscircuit to automatically
@@ -16,4 +17,4 @@ button on the right side of the page.
 After connecting to GitHub, every time you merge a small GitHub action will
 run to update the circuit on tscircuit.com. You 
 
-![Github Commit Status](/img/guides/connect-to-github/github-commit-status-success.png)
+![Github Commit Status](/img/guides/connect-to-github/github-commit-status-success.png)
diff --git a/docs/guides/running-tscircuit/displaying-circuit-json-on-a-webpage.mdx b/docs/guides/running-tscircuit/displaying-circuit-json-on-a-webpage.mdx
@@ -1,5 +1,6 @@
 ---
 title: Displaying Circuit JSON on a Webpage
+description: Render Circuit JSON in web apps using RunFrame and related components
 ---
 
 [Circuit JSON](https://github.com/tscircuit/circuit-json) is a universal
diff --git a/docs/guides/running-tscircuit/programmatically-building-circuits.md b/docs/guides/running-tscircuit/programmatically-building-circuits.md
@@ -1,5 +1,6 @@
 ---
 title: Programmatically Building Circuits
+description: Use tscircuit libraries and APIs to generate circuits from scripts or services
 ---
 
 This guide is about using tscircuit inside of scripts, APIs or inside the browser. Maybe you want to create a website that allows your users drag'n'drop to create custom electronics and turn their designs into real circuits automatically.
diff --git a/docs/guides/running-tscircuit/using-tscircuit-without-react.mdx b/docs/guides/running-tscircuit/using-tscircuit-without-react.mdx
@@ -1,5 +1,6 @@
 ---
 title: Using tscircuit without React
+description: Explore current options for running tscircuit outside of a React environment
 ---
 
 {/* tscircuit uses React by default for strong guarantees about how
@@ -16,4 +17,3 @@ Are you interested in using tscircuit inside an iframe? Check out [this article]
 :::
 
 
-
diff --git a/docs/guides/typescript-guide/using-react-context-to-avoid-prop-drilling.mdx b/docs/guides/typescript-guide/using-react-context-to-avoid-prop-drilling.mdx
@@ -1,5 +1,6 @@
 ---
 title: Using React Context to Avoid Prop-Drilling
+description: Share circuit configuration in TypeScript projects with React context providers
 ---
 
 import CircuitPreview from "@site/src/components/CircuitPreview"
diff --git a/docs/guides/typescript-guide/using-typescript-path-aliases.mdx b/docs/guides/typescript-guide/using-typescript-path-aliases.mdx
@@ -1,5 +1,6 @@
 ---
 title: Using TypeScript Path Aliases
+description: Configure path aliases to simplify imports in tscircuit TypeScript projects
 ---
 
 import CircuitPreview from '@site/src/components/CircuitPreview';
diff --git a/docs/intro/quickstart-web.md b/docs/intro/quickstart-web.md
@@ -1,5 +1,6 @@
 ---
 title: Quickstart Web
+description: Build and preview tscircuit projects directly in the online editor
 sidebar_position: 3
 ---
 
diff --git a/docs/intro/what-is-tscircuit.mdx b/docs/intro/what-is-tscircuit.mdx
@@ -1,6 +1,7 @@
 ---
 title: What is tscircuit?
 slug: /
+description: Learn what tscircuit is and how the React-powered toolchain works
 sidebar_position: 1
 ---
 
diff --git a/docs/web-apis/compile-api.md b/docs/web-apis/compile-api.md
@@ -1,5 +1,6 @@
 ---
 title: Compile API
+description: Compile tscircuit code into Circuit JSON through the hosted API
 sidebar_position: 2
 ---
 
@@ -104,4 +105,3 @@ Returns a status indicating if the service is operational. The response also inc
 ```bash
 bun run start
 ```
-
diff --git a/docs/web-apis/datasheet-api.md b/docs/web-apis/datasheet-api.md
@@ -1,5 +1,6 @@
 ---
 title: Datasheet API
+description: Store and retrieve structured component datasheets via the tscircuit API
 sidebar_position: 4
 ---
 
diff --git a/docs/web-apis/image-generation-api.mdx b/docs/web-apis/image-generation-api.mdx
@@ -1,3 +1,8 @@
+---
+title: Image Generation API
+description: Generate PCB, schematic, and 3D previews from tscircuit code using hosted endpoints
+---
+
 # Image Generation API
 
 The tscircuit image generation API allows you to dynamically create visual representations of your circuits in various formats. This guide explains how to use the dedicated subdomains for generating SVGs, PNGs, and 3D renderings of your circuits.
@@ -203,4 +208,4 @@ Free usage of the image generation APIs is rate-limited. For production applicat
 - Cache images when possible to reduce bandwidth and processing overhead
 - Use appropriate image dimensions to minimize bandwidth
 - For interactive applications, use lower quality/size during manipulation, then higher quality for final rendering
-- When embedding in web applications, include width and height attributes to prevent layout shifts
+- When embedding in web applications, include width and height attributes to prevent layout shifts
diff --git a/docs/web-apis/the-registry-api.md b/docs/web-apis/the-registry-api.md
@@ -1,5 +1,6 @@
 ---
 title: Registry API
+description: Use the tscircuit registry for package management, bundling, and advanced endpoints
 sidebar_position: 1
 ---
 
