Add descriptions to all docs so that llms.txt works better (#39284)

thomasballinger · Convex, Inc. · commit c34dd374ccae · 2025-07-20T21:56:55.000Z
GitOrigin-RevId: f86b873bfb97e99369c3d689ddf3612826a9198a
diff --git a/npm-packages/docs/docs/auth/advanced/custom-auth.mdx b/npm-packages/docs/docs/auth/advanced/custom-auth.mdx
@@ -2,6 +2,9 @@
 title: "Custom OIDC Provider"
 sidebar_label: "Custom OIDC Provider"
 sidebar_position: 3
+description:
+  "Integrate Convex with any OpenID Connect identity provider using custom
+  authentication configuration and ConvexProviderWithAuth."
 ---
 
 **Note: This is an advanced feature!** We recommend sticking with the
diff --git a/npm-packages/docs/docs/auth/advanced/custom-jwt.mdx b/npm-packages/docs/docs/auth/advanced/custom-jwt.mdx
@@ -2,6 +2,9 @@
 title: "Custom JWT Provider"
 sidebar_label: "Custom JWT Provider"
 sidebar_position: 4
+description:
+  "Configure Convex to work with custom JWT providers that don't implement full
+  OIDC protocol, including setup and client-side integration."
 ---
 
 **Note: This is an advanced feature!** We recommend sticking with the
diff --git a/npm-packages/docs/docs/cli.md b/npm-packages/docs/docs/cli.md
@@ -2,6 +2,7 @@
 title: "CLI"
 sidebar_position: 110
 slug: "cli"
+description: "Command-line interface for managing Convex projects and functions"
 ---
 
 The Convex command-line interface (CLI) is your interface for managing Convex
diff --git a/npm-packages/docs/docs/cli/background-agents.mdx b/npm-packages/docs/docs/cli/background-agents.mdx
@@ -3,6 +3,8 @@ title: "Agent Mode"
 slug: "agent-mode"
 sidebar_position: 20
 sidebar_label: "Agent Mode"
+description:
+  "Configure anonymous development mode for cloud-based coding agents"
 ---
 
 When logged in on your own machine, agents like Cursor and Claude Code can run
diff --git a/npm-packages/docs/docs/cli/deploy-key-types.mdx b/npm-packages/docs/docs/cli/deploy-key-types.mdx
@@ -3,6 +3,8 @@ title: "Deploy keys"
 slug: "deploy-key-types"
 sidebar_position: 30
 sidebar_label: "Deploy keys"
+description:
+  "Use deploy keys for authentication in production build environments"
 ---
 
 When you can't log in or use the CLI interactively to specify a project or
diff --git a/npm-packages/docs/docs/cli/local-deployments-for-dev.mdx b/npm-packages/docs/docs/cli/local-deployments-for-dev.mdx
@@ -3,6 +3,7 @@ title: "Local Deployments for Development"
 slug: "local-deployments"
 sidebar_position: 10
 sidebar_label: "Local Deployments"
+description: "Develop with Convex using deployments running locally on your machine"
 ---
 
 Instead of syncing code to a Convex dev deployment hosted in the cloud, you can
diff --git a/npm-packages/docs/docs/client/android.md b/npm-packages/docs/docs/client/android.md
@@ -2,6 +2,8 @@
 title: "Android Kotlin"
 sidebar_label: "Android Kotlin"
 sidebar_position: 600
+description:
+  "Android Kotlin client library for mobile applications using Convex"
 ---
 
 Convex Android client library enables your Android application to interact with
diff --git a/npm-packages/docs/docs/client/javascript.mdx b/npm-packages/docs/docs/client/javascript.mdx
@@ -2,6 +2,8 @@
 title: "JavaScript"
 sidebar_label: "JavaScript"
 sidebar_position: 350
+description:
+  "JavaScript clients for Node.js and browser applications using Convex"
 ---
 
 import Http from "!!raw-loader!@site/../private-demos/snippets/src/vanilla.ts";
diff --git a/npm-packages/docs/docs/client/javascript/bun.mdx b/npm-packages/docs/docs/client/javascript/bun.mdx
@@ -2,6 +2,7 @@
 title: "Bun"
 hidden: false
 sidebar_position: 200
+description: "Use Convex clients with the Bun JavaScript runtime"
 ---
 
 [Bun](https://bun.sh/) can be used to run scripts and servers that use Convex
diff --git a/npm-packages/docs/docs/client/javascript/node.mdx b/npm-packages/docs/docs/client/javascript/node.mdx
@@ -2,6 +2,7 @@
 title: "Node.js"
 hidden: false
 sidebar_position: 100
+description: "Use Convex HTTP and subscription clients in Node.js applications"
 ---
 
 Convex supports point-in-time queries (see
diff --git a/npm-packages/docs/docs/client/javascript/script-tag.mdx b/npm-packages/docs/docs/client/javascript/script-tag.mdx
@@ -1,6 +1,8 @@
 ---
 title: "Script Tag"
 sidebar_position: 100
+description:
+  "Use Convex directly in HTML with script tags, no build tools required"
 ---
 
 Sometimes you just want to get your data on a web page: no installing packages,
diff --git a/npm-packages/docs/docs/client/python.md b/npm-packages/docs/docs/client/python.md
@@ -1,6 +1,7 @@
 ---
 title: "Python"
 sidebar_position: 400
+description: "Python client library for building applications with Convex"
 ---
 
 See the [Python Quickstart](/quickstart/python.mdx) and the
diff --git a/npm-packages/docs/docs/client/react.mdx b/npm-packages/docs/docs/client/react.mdx
@@ -2,6 +2,7 @@
 title: "Convex React"
 sidebar_label: "React"
 sidebar_position: 4
+description: "React client library for interacting with your Convex backend"
 ---
 
 import SkipBad from "!!raw-loader!@site/../private-demos/snippets/src/reactSkipBad.tsx";
diff --git a/npm-packages/docs/docs/client/react/nextjs-pages-router/nextjs-pages-router.mdx b/npm-packages/docs/docs/client/react/nextjs-pages-router/nextjs-pages-router.mdx
@@ -3,6 +3,9 @@ title: "Next.js Pages Router"
 slug: "nextjs-pages-router"
 sidebar_position: 250
 sidebar_label: "Next.js Pages Router"
+description:
+  "Complete guide to using Convex with Next.js Pages Router including
+  client-side authentication, API routes, and server-side rendering."
 ---
 
 import simpleAuthedAppTSX from "!!raw-loader!@site/../demos/nextjs-pages-router/pages/_simpleAuthedApp.tsx";
diff --git a/npm-packages/docs/docs/client/react/nextjs-pages-router/quickstart-nextjs-pages-router.mdx b/npm-packages/docs/docs/client/react/nextjs-pages-router/quickstart-nextjs-pages-router.mdx
@@ -3,6 +3,9 @@ title: Next.js Pages Quickstart
 sidebar_label: Quickstart
 hide_table_of_contents: true
 slug: "quickstart"
+description:
+  "Get started with Convex in Next.js Pages Router by building a reactive task
+  list app with queries, mutations, and real-time updates."
 ---
 
 import sampleData from "!!raw-loader!@site/../private-demos/quickstarts/nextjs/sampleData.jsonl";
diff --git a/npm-packages/docs/docs/client/react/nextjs/nextjs-server-rendering.mdx b/npm-packages/docs/docs/client/react/nextjs/nextjs-server-rendering.mdx
@@ -3,6 +3,9 @@ title: "Next.js Server Rendering"
 slug: "server-rendering"
 sidebar_label: "Server Rendering"
 sidebar_position: 10
+description:
+  "Implement server-side rendering with Convex in Next.js App Router using
+  preloadQuery, fetchQuery, and server actions for improved performance."
 ---
 
 import PreloadQuery from "!!raw-loader!@site/../private-demos/nextjs-app-router-snippets/app/TasksWrapper.tsx";
diff --git a/npm-packages/docs/docs/client/react/optimistic-updates.mdx b/npm-packages/docs/docs/client/react/optimistic-updates.mdx
@@ -3,6 +3,7 @@ title: "Optimistic Updates"
 slug: "optimistic-updates"
 hidden: false
 sidebar_position: 90
+description: "Make your React app more responsive with optimistic UI updates"
 ---
 
 import Simple from "!!raw-loader!@site/../private-demos/snippets/src/optimisticUpdatesSimple.tsx";
diff --git a/npm-packages/docs/docs/client/react/tanstack-start/clerk.mdx b/npm-packages/docs/docs/client/react/tanstack-start/clerk.mdx
@@ -3,6 +3,9 @@ title: "TanStack Start with Clerk"
 slug: "tanstack-start-with-clerk"
 sidebar_label: With Clerk
 sidebar_position: 10
+description:
+  "Learn how to integrate Clerk authentication with Convex in TanStack Start
+  applications using ID tokens and ConvexProviderWithClerk."
 ---
 
 import appRouter from "!!raw-loader!@site/../private-demos/tanstack-start-clerk/app/router.tsx";
diff --git a/npm-packages/docs/docs/client/rust.md b/npm-packages/docs/docs/client/rust.md
@@ -1,6 +1,7 @@
 ---
 title: "Rust"
 sidebar_position: 500
+description: "Rust client library for building applications with Convex"
 ---
 
 See the [Rust Quickstart](/quickstart/rust.mdx) and
diff --git a/npm-packages/docs/docs/client/svelte.md b/npm-packages/docs/docs/client/svelte.md
@@ -1,6 +1,7 @@
 ---
 title: "Svelte"
 sidebar_position: 250
+description: "Reactive Svelte client library for Convex applications"
 ---
 
 Convex is a great fit for reactive UI frameworks like Svelte. The
diff --git a/npm-packages/docs/docs/client/swift.md b/npm-packages/docs/docs/client/swift.md
@@ -2,6 +2,7 @@
 title: "iOS & macOS Swift"
 sidebar_label: "Swift"
 sidebar_position: 700
+description: "Swift client library for iOS and macOS applications using Convex"
 ---
 
 The Convex Swift client library enables your iOS or macOS application to
diff --git a/npm-packages/docs/docs/client/tanstack-query.mdx b/npm-packages/docs/docs/client/tanstack-query.mdx
@@ -2,6 +2,8 @@
 title: "Convex with TanStack Query"
 sidebar_label: "TanStack Query"
 sidebar_position: 325
+description:
+  "Integrate Convex with TanStack Query for advanced data fetching patterns"
 ---
 
 import Setup from "!!raw-loader!@site/../demos/react-query/src/main.tsx";
diff --git a/npm-packages/docs/docs/client/vue.md b/npm-packages/docs/docs/client/vue.md
@@ -1,6 +1,7 @@
 ---
 title: "Vue"
 sidebar_position: 250
+description: "Community-maintained Vue integration for Convex applications"
 ---
 
 The community-maintained
diff --git a/npm-packages/docs/docs/dashboard/deployments/data.md b/npm-packages/docs/docs/dashboard/deployments/data.md
@@ -2,6 +2,8 @@
 title: "Data"
 slug: "data"
 sidebar_position: 5
+description:
+  "View, edit, and manage database tables and documents in the dashboard"
 ---
 
 ![Data Dashboard Page](/screenshots/data.png)
diff --git a/npm-packages/docs/docs/dashboard/deployments/deployments.md b/npm-packages/docs/docs/dashboard/deployments/deployments.md
@@ -2,6 +2,9 @@
 title: "Deployments"
 id: "deployments"
 sidebar_position: 20
+description:
+  "Understand Convex deployments including production, development, and preview
+  deployments, and how to switch between them in the dashboard."
 ---
 
 Each project in Convex has a main production deployment, and each developer on
diff --git a/npm-packages/docs/docs/dashboard/deployments/files.md b/npm-packages/docs/docs/dashboard/deployments/files.md
@@ -3,6 +3,8 @@ title: "File Storage"
 sidebar_label: "Files"
 slug: "file-storage"
 sidebar_position: 20
+description:
+  "Upload, download, and manage files stored in your Convex deployment"
 ---
 
 The [file storage page](https://dashboard.convex.dev/deployment/files) displays
diff --git a/npm-packages/docs/docs/dashboard/deployments/functions.md b/npm-packages/docs/docs/dashboard/deployments/functions.md
@@ -2,6 +2,8 @@
 title: "Functions"
 slug: "functions"
 sidebar_position: 10
+description:
+  "Run, test, and monitor Convex functions with metrics and performance data"
 ---
 
 ![Functions Dashboard View](/screenshots/functions.png)
diff --git a/npm-packages/docs/docs/dashboard/deployments/health.md b/npm-packages/docs/docs/dashboard/deployments/health.md
@@ -2,6 +2,9 @@
 title: "Health"
 slug: "health"
 sidebar_position: 0
+description:
+  "Monitor your Convex deployment health including failure rates, cache
+  performance, scheduler status, and deployment insights for optimization."
 ---
 
 The [health page](https://dashboard.convex.dev/deployment/) is the landing page
diff --git a/npm-packages/docs/docs/dashboard/deployments/history.md b/npm-packages/docs/docs/dashboard/deployments/history.md
@@ -2,6 +2,10 @@
 title: "History"
 slug: "history"
 sidebar_position: 50
+description:
+  "View an audit log of configuration-related events in your Convex deployment
+  including function deployments, index changes, and environment variable
+  updates."
 ---
 
 ![History Dashboard Page](/screenshots/history.png)
diff --git a/npm-packages/docs/docs/dashboard/deployments/logs.md b/npm-packages/docs/docs/dashboard/deployments/logs.md
@@ -2,6 +2,8 @@
 title: "Logs"
 slug: "logs"
 sidebar_position: 40
+description:
+  "View real-time function logs and deployment activity in your dashboard"
 ---
 
 ![Logs Dashboard Page](/screenshots/logs.png)
diff --git a/npm-packages/docs/docs/dashboard/deployments/schedules.md b/npm-packages/docs/docs/dashboard/deployments/schedules.md
@@ -2,6 +2,8 @@
 title: "Schedules"
 slug: "schedules"
 sidebar_position: 30
+description:
+  "Monitor and manage scheduled functions and cron jobs in your deployment"
 ---
 
 The [schedules page](https://dashboard.convex.dev/deployment/schedules) displays
diff --git a/npm-packages/docs/docs/dashboard/deployments/settings.md b/npm-packages/docs/docs/dashboard/deployments/settings.md
@@ -2,6 +2,9 @@
 title: "Settings"
 slug: "deployment-settings"
 sidebar_position: 60
+description:
+  "Configure your Convex deployment settings including URLs, environment
+  variables, authentication, backups, integrations, and deployment management."
 ---
 
 The [deployment settings page](https://dashboard.convex.dev/deployment/settings)
diff --git a/npm-packages/docs/docs/dashboard/projects.md b/npm-packages/docs/docs/dashboard/projects.md
@@ -2,6 +2,7 @@
 title: "Projects"
 slug: "projects"
 sidebar_position: 10
+description: "Create and manage Convex projects, settings, and deployments"
 ---
 
 ![Project settings](/screenshots/projects.png)
diff --git a/npm-packages/docs/docs/dashboard/teams.md b/npm-packages/docs/docs/dashboard/teams.md
@@ -2,6 +2,8 @@
 title: "Teams"
 slug: "teams"
 sidebar_position: 0
+description:
+  "Manage team settings, members, billing, and access control in Convex"
 ---
 
 In Convex, your projects are organized by team. Teams are used to share access
diff --git a/npm-packages/docs/docs/database/advanced/system-tables.mdx b/npm-packages/docs/docs/database/advanced/system-tables.mdx
@@ -1,6 +1,9 @@
 ---
 title: "System Tables"
 sidebar_position: 1
+description:
+  "Access metadata for Convex built-in features through system tables including
+  scheduled functions and file storage information."
 ---
 
 System tables enable read-only access to metadata for built-in Convex features.
diff --git a/npm-packages/docs/docs/generated-api/api.md b/npm-packages/docs/docs/generated-api/api.md
@@ -1,6 +1,8 @@
 ---
 title: "api.js"
 sidebar_position: 2
+description:
+  "Generated API references for your Convex functions and internal calls"
 ---
 
 <Admonition type="caution" title="This code is generated">
diff --git a/npm-packages/docs/docs/generated-api/data-model.md b/npm-packages/docs/docs/generated-api/data-model.md
@@ -1,6 +1,7 @@
 ---
 title: "dataModel.d.ts"
 sidebar_position: 1
+description: "Generated TypeScript types for your database schema and documents"
 ---
 
 <Admonition type="caution" title="This code is generated">
diff --git a/npm-packages/docs/docs/generated-api/index.md b/npm-packages/docs/docs/generated-api/index.md
@@ -1,5 +1,7 @@
 ---
 title: Generated Code
+description:
+  "Auto-generated JavaScript and TypeScript code specific to your app's API"
 ---
 
 Convex uses code generation to create code that is specific to your app's data
diff --git a/npm-packages/docs/docs/generated-api/server.md b/npm-packages/docs/docs/generated-api/server.md
@@ -1,6 +1,8 @@
 ---
 title: "server.js"
 sidebar_position: 4
+description:
+  "Generated utilities for implementing Convex queries, mutations, and actions"
 ---
 
 <Admonition type="caution" title="This code is generated">
diff --git a/npm-packages/docs/docs/production/contact.md b/npm-packages/docs/docs/production/contact.md
@@ -1,6 +1,9 @@
 ---
 title: "Contact Us"
 sidebar_position: 500
+description:
+  "Get support, provide feedback, stay updated with Convex releases, and report
+  security vulnerabilities through our community channels."
 ---
 
 Convex is a rapidly developing platform and we're always eager to hear your
diff --git a/npm-packages/docs/docs/production/pause-deployment.mdx b/npm-packages/docs/docs/production/pause-deployment.mdx
@@ -2,6 +2,7 @@
 title: "Pausing a Deployment"
 sidebar_label: "Pausing a Deployment"
 sidebar_position: 4
+description: "Temporarily disable a deployment without deleting data"
 ---
 
 Pausing a deployment is a way to "turn off" a deployment without deleting any
diff --git a/npm-packages/docs/docs/production/project-configuration.mdx b/npm-packages/docs/docs/production/project-configuration.mdx
@@ -2,6 +2,9 @@
 title: "Project Configuration"
 sidebar_label: "Project Configuration"
 sidebar_position: 3
+description:
+  "Configure your Convex project for development and production deployment using
+  convex.json, environment variables, and deployment settings."
 ---
 
 ## Local development
diff --git a/npm-packages/docs/docs/production/state/state.mdx b/npm-packages/docs/docs/production/state/state.mdx
@@ -2,6 +2,9 @@
 title: "Status and Guarantees"
 id: "state"
 sidebar_position: 1
+description:
+  "Learn about Convex's production guarantees, availability targets, data
+  durability, security features, and upcoming platform enhancements."
 ---
 
 Please [contact us](mailto:support@convex.dev) with any specific requirements or
diff --git a/npm-packages/docs/docs/tutorial/actions.mdx b/npm-packages/docs/docs/tutorial/actions.mdx
@@ -4,6 +4,9 @@ sidebar_label: "2. Calling external services"
 slug: "actions"
 sidebar_position: 200
 hide_table_of_contents: true
+description:
+  "Extend your chat app by calling external APIs using Convex actions and the
+  scheduler to integrate Wikipedia summaries into your application."
 ---
 
 # Convex Tutorial: Calling external services
diff --git a/npm-packages/docs/docs/tutorial/index.mdx b/npm-packages/docs/docs/tutorial/index.mdx
diff --git a/npm-packages/docs/docs/tutorial/scale.mdx b/npm-packages/docs/docs/tutorial/scale.mdx
diff --git a/npm-packages/docs/docs/understanding/best-practices/best-practices.mdx b/npm-packages/docs/docs/understanding/best-practices/best-practices.mdx
diff --git a/npm-packages/docs/docs/understanding/best-practices/other-recommendations.mdx b/npm-packages/docs/docs/understanding/best-practices/other-recommendations.mdx
diff --git a/npm-packages/docs/docs/understanding/index.mdx b/npm-packages/docs/docs/understanding/index.mdx
