Migrate docs to Vocs v2 (#114)

Author: technophile-04

.changeset/debug-contracts-use-client.md

@@ -0,0 +1,5 @@
+---
+"@scaffold-ui/debug-contracts": patch
+---
+
+Mark `Contract` and `IntegerInput` as client components (`"use client"`). Both call React hooks, so importing them into a React Server Component (Next.js App Router, Vocs v2) previously threw at render. The components package already marks its interactive components this way; this brings debug-contracts in line.

.github/workflows/release.yml

@@ -37,8 +37,12 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      # Build only the publishable packages, not the docs/example apps. A package
+      # release has no reason to build the docs site, and doing so would drag in
+      # Vite 8 / rolldown, whose native binding pnpm's hoisted linker doesn't link
+      # on a plain CI install.
       - name: Build packages
-        run: pnpm build
+        run: pnpm build:packages
 
       - name: Create Release Pull Request or Publish to npm
         id: changesets

.gitignore

@@ -1,9 +1,10 @@
 node_modules
 .pnpm-store/
 .pnpm-debug.log
+.vercel
 
 # Generated at build time by docs/scripts/gen-sitemap.ts (see docs/vocs.config.ts)
 docs/public/sitemap.xml
 
-# Generated at build time by docs/scripts/gen-agent-skills-index.ts
-docs/public/.well-known/
+# Generated at build time by docs/scripts/gen-agent-skills-index.ts (the MCP server card alongside it is committed)
+docs/public/.well-known/agent-skills/

docs/.gitignore

@@ -1,3 +1,11 @@
+node_modules
 dist
+.vocs
 .env
-.env.*
+.env.*
+
+# Vocs route manifest (generated at dev/build)
+src/pages.gen.ts
+
+# Generated by scripts/gen-agent-skills-index.ts (the MCP server card alongside it is committed)
+public/.well-known/agent-skills/

docs/package.json

@@ -4,8 +4,9 @@
   "description": "Documentation for scaffold-ui components",
   "type": "module",
   "scripts": {
-    "dev": "vocs dev",
-    "build": "pnpm --filter @scaffold-ui/hooks --filter @scaffold-ui/components --filter @scaffold-ui/debug-contracts run build && vocs build",
+    "generate": "tsx scripts/generate.ts",
+    "dev": "pnpm generate && vocs dev",
+    "build": "pnpm --filter @scaffold-ui/hooks --filter @scaffold-ui/components --filter @scaffold-ui/debug-contracts run build && pnpm generate && vocs build",
     "preview": "vocs preview",
     "format": "prettier --write ."
   },
@@ -21,15 +22,21 @@
     "@scaffold-ui/debug-contracts": "workspace:*",
     "@scaffold-ui/hooks": "workspace:*",
     "@tanstack/react-query": "^5.59.15",
-    "@types/react": "^19",
-    "@types/react-dom": "^19",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
     "viem": "^2.23.13",
-    "vocs": "^1.0.13",
-    "wagmi": "^2.14.15"
+    "vocs": "^2.3.1",
+    "wagmi": "^2.14.15",
+    "waku": "^1.0.0-beta.3"
   },
   "devDependencies": {
-    "prettier": "^3.5.3"
+    "@types/node": "^22",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@vitejs/plugin-react": "^6",
+    "prettier": "^3.5.3",
+    "tsx": "^4",
+    "typescript": "^5",
+    "vite": "^8"
   }
 }

docs/public/.well-known/mcp/server-card.json

@@ -0,0 +1,30 @@
+{
+  "name": "io.scaffoldeth.ui",
+  "title": "Scaffold-UI Docs",
+  "description": "MCP server for the Scaffold-UI documentation. Lets AI clients list, read, and search the docs.",
+  "version": "1.0.0",
+  "websiteUrl": "https://ui.scaffoldeth.io",
+  "repository": {
+    "url": "https://github.com/scaffold-eth/scaffold-ui",
+    "source": "github"
+  },
+  "serverInfo": {
+    "name": "vocs",
+    "version": "1.0.0"
+  },
+  "transport": {
+    "type": "streamable-http",
+    "endpoint": "https://ui.scaffoldeth.io/api/mcp"
+  },
+  "capabilities": {
+    "tools": true,
+    "resources": false,
+    "prompts": false
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://ui.scaffoldeth.io/api/mcp"
+    }
+  ]
+}

docs/public/robots.txt

@@ -1,67 +1,8 @@
-# Scaffold UI documentation is open-source and intended to be
-# discoverable by search engines and AI agents. Crawl freely.
+# Scaffold-UI documentation is open-source and meant to be discoverable
+# by search engines and AI agents. Crawl freely.
 
 User-agent: *
 Allow: /
 Content-Signal: ai-train=yes, search=yes, ai-input=yes
 
-# AI training and search crawlers — explicitly allowed so agents can
-# index Scaffold UI components, hooks, and recipes.
-User-agent: GPTBot
-Allow: /
-
-User-agent: ChatGPT-User
-Allow: /
-
-User-agent: OAI-SearchBot
-Allow: /
-
-User-agent: ClaudeBot
-Allow: /
-
-User-agent: Claude-SearchBot
-Allow: /
-
-User-agent: Claude-User
-Allow: /
-
-User-agent: anthropic-ai
-Allow: /
-
-User-agent: PerplexityBot
-Allow: /
-
-User-agent: Perplexity-User
-Allow: /
-
-User-agent: Google-Extended
-Allow: /
-
-User-agent: Googlebot
-Allow: /
-
-User-agent: Applebot
-Allow: /
-
-User-agent: Applebot-Extended
-Allow: /
-
-User-agent: CCBot
-Allow: /
-
-User-agent: Bytespider
-Allow: /
-
-User-agent: Meta-ExternalAgent
-Allow: /
-
-User-agent: FacebookBot
-Allow: /
-
-User-agent: cohere-ai
-Allow: /
-
-User-agent: MistralAI-User
-Allow: /
-
 Sitemap: https://ui.scaffoldeth.io/sitemap.xml

docs/scripts/gen-sitemap.ts

@@ -0,0 +1,7 @@
+import { generateAgentSkillsIndex } from "./gen-agent-skills-index";
+
+// Runs before `vocs dev` / `vocs build` (see package.json). Builds the
+// agent-skills discovery index that lives at /.well-known/agent-skills/index.json.
+// Vocs v2 emits sitemap.xml / robots.txt / llms.txt natively, so the old
+// gen-sitemap step is gone.
+generateAgentSkillsIndex();