Include generated docs in local circuit prompt

Author: Phil

lib/prompt-templates/create-local-circuit-prompt.ts

@@ -1,7 +1,7 @@
 import {
+  fp,
   getFootprintNamesByType,
   getFootprintSizes,
-  fp,
 } from "@tscircuit/footprinter"
 
 async function fetchFileContent(url: string): Promise<string> {
@@ -19,6 +19,16 @@ async function fetchFileContent(url: string): Promise<string> {
   }
 }
 
+async function fetchOptionalFileContent(url: string): Promise<string> {
+  try {
+    const response = await fetch(url)
+    if (!response.ok) return ""
+    return await response.text()
+  } catch {
+    return ""
+  }
+}
+
 export const createLocalCircuitPrompt = async () => {
   const footprintNamesByType = getFootprintNamesByType()
   const footprintSizes = getFootprintSizes()
@@ -38,6 +48,10 @@ export const createLocalCircuitPrompt = async () => {
       "https://raw.githubusercontent.com/tscircuit/props/main/generated/COMPONENT_TYPES.md",
     )) || ""
 
+  const generatedDocs = (
+    await fetchOptionalFileContent("https://docs.tscircuit.com/ai.txt")
+  ).trim()
+
   const cleanedPropsDoc = propsDoc
     .split("\n")
     .filter((line) => !line.startsWith("#"))
@@ -53,6 +67,17 @@ YOU MUST ABIDE BY THE RULES IN THE RULES SECTION
 
 Here's an overview of the tscircuit API:
 
+${
+  generatedDocs
+    ? `## Generated tscircuit docs
+
+The following documentation is generated from the current tscircuit docs site:
+
+${generatedDocs}
+`
+    : ""
+}
+
 <board width="10mm" height="10mm" /> // usually the root component
 <board outline={[{x: 0, y: 0}, {x: 10, y: 0}, {x: 10, y: 10}, {x: 0, y: 10}]} /> // custom shape instead of rectangle
 <led pcbX="5mm" pcbY="5mm" />

tests/prompt-templates/create-local-circuit-prompt.test.ts

@@ -0,0 +1,42 @@
+import { afterEach, expect, test } from "bun:test"
+import { createLocalCircuitPrompt } from "lib/prompt-templates/create-local-circuit-prompt"
+
+const originalFetch = globalThis.fetch
+
+afterEach(() => {
+  globalThis.fetch = originalFetch
+})
+
+test("createLocalCircuitPrompt includes generated ai docs when available", async () => {
+  globalThis.fetch = (async (input: RequestInfo | URL) => {
+    const url = String(input)
+
+    if (url === "https://docs.tscircuit.com/ai.txt") {
+      return new Response("Use <chip /> pinLabels for IC pins.")
+    }
+
+    return new Response("# Props\n\n<resistor /> props")
+  }) as typeof fetch
+
+  const prompt = await createLocalCircuitPrompt()
+
+  expect(prompt).toContain("## Generated tscircuit docs")
+  expect(prompt).toContain("Use <chip /> pinLabels for IC pins.")
+})
+
+test("createLocalCircuitPrompt still builds when generated ai docs cannot be fetched", async () => {
+  globalThis.fetch = (async (input: RequestInfo | URL) => {
+    const url = String(input)
+
+    if (url === "https://docs.tscircuit.com/ai.txt") {
+      return new Response("not found", { status: 404 })
+    }
+
+    return new Response("# Props\n\n<resistor /> props")
+  }) as typeof fetch
+
+  const prompt = await createLocalCircuitPrompt()
+
+  expect(prompt).toContain("Here's an overview of the tscircuit API")
+  expect(prompt).not.toContain("## Generated tscircuit docs")
+})