Qol updates (#7490)

mhartington · web-flow · commit e1c65e92c832 · 2026-02-13T09:34:09.000-05:00
* chore(): some quality of life improvments

* chore(): add missing env var

* fix: correct sync with mxdai
diff --git a/.github/workflows/docs-test.yml b/.github/workflows/docs-test.yml
@@ -32,6 +32,8 @@ jobs:
 
       - name: Build docs app
         run: pnpm --filter=docs run build
+        env:
+          MIXEDBREAD_API_KEY: ${{ secrets.MIXEDBREAD_API_KEY }}
 
       - name: Run Playwright tests
         run: pnpm --filter=docs exec playwright test
diff --git a/.github/workflows/mxbai.yml b/.github/workflows/mxbai.yml
@@ -0,0 +1,38 @@
+name: Sync Mixedbread Vector Store
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+    paths: [apps/docs/content/docs/**/*.mdx]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  test:
+    name: Sync Docs
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "pnpm"
+
+      - name: Upload Docs
+        run: pnpm dlx mixedbread/cli store sync "${MIXEDBREAD_VECTOR_STORE_ID}" "apps/docs/content/docs/**/*.mdx" --yes --strategy fast
+        env:
+          MIXEDBREAD_API_KEY: ${{ secrets.MIXEDBREAD_API_KEY }}
+          MIXEDBREAD_VECTOR_STORE_ID: ${{ secrets.MIXEDBREAD_VECTOR_STORE_ID }}
diff --git a/README.md b/README.md
@@ -2,130 +2,75 @@
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/prisma/docs/blob/main/CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/937751382725886062)](https://discord.com/invite/prisma-937751382725886062?utm_source=twitter&utm_medium=bio&dub_id=0HxLEKaaOg6pL0OL)
 
-This repository contains the [source code](./src) and the [content](./content) for the [Prisma documentation](https://www.prisma.io/docs).
+This repository is a **pnpm monorepo** containing the Prisma documentation, blog, design system docs, and shared packages.
 
-## Contributing to the docs
+## Repository structure
 
-New contributors are welcome! Read through the [contributing guide](CONTRIBUTING.md) to learn how you can contribute to the Prisma documentation.
+| Path | Description |
+|------|--------------|
+| `apps/docs` | Prisma documentation site (Next.js + Fumadocs) |
+| `apps/blog` | Prisma blog |
+| `apps/eclipse` | Eclipse design system documentation |
+| `packages/eclipse` | Eclipse design system component library (`@prisma-docs/eclipse`) |
+| `packages/ui` | Shared UI components and utilities (`@prisma-docs/ui`) |
 
-## Run the docs site locally
+See each app’s `README.md` for more detail.
 
-1. Clone this repository.
-2. On your computer, open a terminal window in the repository's directory.
-3. Run the following commands:
+## Contributing
 
-```
-npm install
-npm run start
-```
-
-Be sure to also test building the static site:
+New contributors are welcome. Read the [contributing guide](CONTRIBUTING.md) before submitting changes.
 
-```
-npm run clean && npm run build
-npm run serve
-```
+## Run locally
 
-To prettify or format the code, run:
+From the repository root:
 
+```bash
+pnpm install
+pnpm dev
 ```
-npm run format
-```
-
-Please note that `.md` and `.mdx` files are not formatted by Prettier because they are written in [MDX 3](https://mdxjs.com/blog/v3/) which Prettier [does not support](https://github.com/prettier/prettier/issues/12209).
-
-Visit `http://localhost:3000` to view the app.
-
-## Configure
-
-Write MDX files in `content` folder.
 
-Most frontmatter for the docs are the same as [Docusaurus Frontmatter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter). There are some differences due to legacy frontmatter which are handled [here](https://github.com/prisma/docs/blob/94b04aa1d8f723802e715b531b9808bab2d7ae15/src/theme/DocItem/Metadata/index.tsx).
+This starts all apps via Turbo:
 
-When possible, avoid using custom frontmatter fields and use the default ones available via Docusaurus.
+- **Docs** — http://localhost:3000  
+- **Blog** — http://localhost:3001  
+- **Eclipse** — http://localhost:3002  
 
-## Inserting, moving and deleting files
-
-All files/folders in the context are prefixed with a _position_ which indicates the order in which they appear in the sidenav on the docs website. This makes it cumbersome to insert, move and delete files because the positions of a number of other files (if not all) in the same folder might need to be adjusted. Thanks to [Luca Steeb](https://github.com/steebchen/), you can perform these operations with a dedicated CLI called [`mdtool`](https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool).
-
-### Install
-
-First, install `wget`:
+To run a single app:
 
 ```bash
-brew install wget
+pnpm --filter docs dev      # docs only
+pnpm --filter blog dev      # blog only
+pnpm --filter eclipse dev   # eclipse design system docs only
 ```
 
-Then use `wget` to install `mdtool`:
+## Build
 
 ```bash
-wget https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool -qO /usr/local/bin/mdtool
-chmod +x /usr/local/bin/mdtool
-```
-
-### Usage
-
-#### Overview
-
-```
-mdtool insert 3
-mdtool swap A B
-mdtool move A B
-mdtool remove 4
+pnpm build
 ```
 
-#### `mdtool insert`
+To build and serve the docs site:
 
-Make place for a new file at given index and increment all numbers by one after that index:
-
-```
-$ mdtool insert INDEX
-
-# e.g.:
-$ mdtool insert 2
-
-# Result: for files 01-a, 02-b, 03-c, and 04-d; 03-c is renamed to 04-c and 04-d is renamed to 05-d so you can create a new file at index 2
-```
-
-#### `mdtool swap`
-
-Swap two files; specify both filenames (prefix numbers get automatically adjusted):
-
-```
-$ mdtool swap FILENAME1 FILENAME2
-
-# e.g.:
-$ mdtool swap 03-file1.mdx 07-file2.mdx
-
-# Result: Files are now named: 03-file2.mdx 07-file1.mdx
-```
-
-#### `mdtool move`
-
-Move a given file to another given index
-
-```
-$ mdtool move FILENAME INDEX
-
-# e.g.:
-$ mdtool move 05-file.mdx 2
-
-# Result: 05-file.mdx is move to 02-file.mdx, plus previous files 02-*, 03-*, 04-* are incremented
+```bash
+pnpm --filter docs build
+pnpm --filter docs start
 ```
 
-#### `mdtool remove`
+## Scripts
 
-Shift all other items by -1 at a given index:
+| Script | Description |
+|--------|-------------|
+| `pnpm lint:links` | Validate internal and external links (docs) |
+| `pnpm lint:code` | Lint code blocks in MDX (docs) |
+| `pnpm lint:spellcheck` | Spell-check content (docs) |
+| `pnpm format` | Format code (`.md` / `.mdx` excluded — see note below) |
 
-```
-$ mdtool remove INDEX
+## Content
 
-# e.g.:
-$ mdtool remove 2
-
-# Result: 01-a, 02-b, 03-c, 04-d becomes 01-a, 02-b, 02-c, 03-d; 02-b is supposed to be manually deleted
-```
+- **Docs** — `apps/docs/content/docs/` (latest), `apps/docs/content/docs.v6/` (versioned). Sidebar structure comes from `meta.json` in each folder. See [Fumadocs collections](https://fumadocs.dev/docs/mdx/collections).
+- **Blog** — `apps/blog/content/blog/` (MDX with authors, dates, hero images).
+- **Eclipse** — `apps/eclipse/content/design-system/` (component docs).
 
-#### Thanks Luca
+## Note on formatting
 
-![](https://res.cloudinary.com/prismaio/image/upload/v1628765536/docs/LJ0FGHk_u2jjxv.png)
+`.md` and `.mdx` files are not formatted by Prettier because they use [MDX 3](https://mdxjs.com/blog/v3/), which Prettier does not support. See [prettier/prettier#12209](https://github.com/prettier/prettier/issues/12209).
diff --git a/apps/blog/README.md b/apps/blog/README.md
@@ -0,0 +1,30 @@
+# Prisma Blog
+
+The **Prisma blog** site. A Next.js app that hosts Prisma’s product updates, announcements, tutorials, and technical posts.
+
+## What it does
+
+- **Blog posts** — MDX articles with authors, dates, hero images, and code examples
+- **Search** — Full-text search over blog content
+- **LLM endpoints** — Routes for AI/LLM consumption of processed blog text (`/llms.mdx/...`, `/llms-full.txt`)
+
+## Run locally
+
+```bash
+pnpm install
+pnpm dev
+```
+
+Runs on **http://localhost:3001** (docs is 3000, eclipse is 3002).
+
+## Structure
+
+- `content/blog/` — MDX blog posts
+- `src/` — App shell, layout, search, and MDX components (TweetEmbed, Youtube, Quote, etc.)
+- Uses [Fumadocs](https://fumadocs.dev) for the blog framework
+- Uses `@prisma-docs/eclipse` for UI components
+
+## Related
+
+- **Docs**: `apps/docs` — Prisma documentation
+- **Design system**: `apps/eclipse` — Eclipse design system docs
diff --git a/apps/docs/content/docs.v6/(index)/index.mdx b/apps/docs/content/docs.v6/(index)/index.mdx
@@ -3,7 +3,7 @@ title: Get Started
 description: Welcome to Prisma! Choose your path below to get started.
 url: /v6
 metaTitle: Get started with Prisma
-metaDescription: 'Build data-driven applications with ease using Prisma ORM, add connection pooling or global caching with Prisma Accelerate.'
+metaDescription: 'Build data-driven applications with ease using Prisma ORM, add connection pooling with Prisma Postgres.'
 ---
 
 ## Prisma ORM
diff --git a/apps/docs/content/docs/(index)/index.mdx b/apps/docs/content/docs/(index)/index.mdx
@@ -3,7 +3,7 @@ title: Introduction to Prisma
 description: Build data-driven applications with ease using Prisma ORM and Prisma Postgres
 url: /
 metaTitle: Get started with Prisma
-metaDescription: 'Build data-driven applications with ease using Prisma ORM, add connection pooling or global caching with Prisma Accelerate.'
+metaDescription: 'Build data-driven applications with ease using Prisma ORM, add connection pooling with Prisma Postgres.'
 ---
 [**Prisma ORM**](/orm) is an open-source ORM that provides fast, type-safe access to Postgres, MySQL, SQLite, and other databases, and runs smoothly across Node.js, Bun, and Deno.
 
diff --git a/apps/eclipse/README.md b/apps/eclipse/README.md
@@ -0,0 +1,30 @@
+# Eclipse Design System Docs
+
+The **documentation site** for the [Eclipse Design System](https://prisma.io/docs/design-system). This Next.js app showcases and documents all components from the `@prisma-docs/eclipse` package.
+
+## What it does
+
+- **Design system documentation** — Interactive docs for Eclipse atoms (Button, Badge, Input, etc.) and molecules (Card, Tabs, CodeBlock, etc.)
+- **Component playground** — Live, editable examples for each component
+- **Reference site** — The main docs (`apps/docs`) imports and uses Eclipse components; this app serves as the component library reference
+
+## Run locally
+
+```bash
+pnpm install
+pnpm dev
+```
+
+Runs on **http://localhost:3002** (docs is 3000, blog is 3001).
+
+## Structure
+
+- `content/design-system/` — MDX docs (atoms, molecules, colors)
+- `src/` — App shell, search, layout, and MDX components
+- Uses [Fumadocs](https://fumadocs.dev) for the doc framework
+- Consumes `@prisma-docs/eclipse` from `packages/eclipse` (workspace package)
+
+## Related
+
+- **Package**: `packages/eclipse` — the actual `@prisma-docs/eclipse` component library
+- **Usage**: `apps/docs` — Prisma docs site that uses Eclipse components
