Split docs CI and GitHub-driven Vercel deploy

Author: TrueNine

.github/actions/setup-node-pnpm/action.yml

@@ -18,6 +18,10 @@ inputs:
     description: Whether to run pnpm install
     required: false
     default: "true"
+  install-filter:
+    description: Optional pnpm filter selector to limit install scope
+    required: false
+    default: ""
 
 runs:
   using: composite
@@ -36,6 +40,13 @@ runs:
         registry-url: ${{ inputs.registry-url }}
 
     - name: Install workspace dependencies
-      if: inputs.install == 'true'
+      if: inputs.install == 'true' && inputs['install-filter'] == ''
       shell: bash
       run: pnpm install --frozen-lockfile --ignore-scripts
+
+    - name: Install filtered workspace dependencies
+      if: inputs.install == 'true' && inputs['install-filter'] != ''
+      shell: bash
+      run: pnpm install --frozen-lockfile --ignore-scripts --filter "$INSTALL_FILTER"
+      env:
+        INSTALL_FILTER: ${{ inputs['install-filter'] }}

.github/workflows/deploy-doc.yml

@@ -6,6 +6,13 @@ on:
       - main
     paths:
       - doc/**
+      - .github/actions/setup-node-pnpm/action.yml
+      - .github/workflows/deploy-doc.yml
+      - .github/workflows/pull-request-doc.yml
+      - package.json
+      - pnpm-lock.yaml
+      - pnpm-workspace.yaml
+      - turbo.json
   workflow_dispatch:
 
 permissions:
@@ -25,9 +32,11 @@ jobs:
     runs-on: ubuntu-24.04
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - uses: ./.github/actions/setup-node-pnpm
+        with:
+          install-filter: "@truenine/memory-sync-docs..."
 
       - name: Preflight Vercel secrets
         shell: bash
@@ -49,11 +58,20 @@ jobs:
             exit 1
           fi
 
+      - name: Lint docs
+        run: pnpm -C doc run lint
+
+      - name: Typecheck docs
+        run: pnpm -C doc run typecheck
+
       - name: Pull Vercel production settings
+        working-directory: ./doc
         run: pnpm dlx vercel@latest pull --yes --environment=production --token="$VERCEL_TOKEN"
 
       - name: Build docs on Vercel
+        working-directory: ./doc
         run: pnpm dlx vercel@latest build --prod --token="$VERCEL_TOKEN"
 
       - name: Deploy docs to Vercel production
+        working-directory: ./doc
         run: pnpm dlx vercel@latest deploy --prebuilt --prod --token="$VERCEL_TOKEN"

.github/workflows/pull-request-doc.yml

@@ -0,0 +1,47 @@
+name: Pull Request Docs
+
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - doc/**
+      - .github/actions/setup-node-pnpm/action.yml
+      - .github/workflows/deploy-doc.yml
+      - .github/workflows/pull-request-doc.yml
+      - package.json
+      - pnpm-lock.yaml
+      - pnpm-workspace.yaml
+      - turbo.json
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  check-doc:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: ./.github/actions/setup-node-pnpm
+        with:
+          install-filter: "@truenine/memory-sync-docs..."
+
+      - name: Validate docs content
+        run: pnpm -C doc run validate:content
+
+      - name: Lint docs
+        run: pnpm -C doc run lint
+
+      - name: Typecheck docs
+        run: pnpm -C doc run typecheck
+
+      - name: Build docs
+        run: pnpm -C doc run build

.github/workflows/pull-request.yml

@@ -14,6 +14,9 @@ on:
       - CODE_OF_CONDUCT.md
       - LICENSE
       - SECURITY.md
+      - doc/**
+      - .github/workflows/deploy-doc.yml
+      - .github/workflows/pull-request-doc.yml
 
 permissions:
   contents: read

doc/components/docs-callout.tsx

@@ -6,6 +6,7 @@ type CalloutTone = 'note' | 'tip' | 'important' | 'warning' | 'caution'
 type BlockquoteProps = ComponentPropsWithoutRef<'blockquote'>
 
 const CALLOUT_PATTERN = /^\s*\[!(note|tip|important|warning|caution)\]\s*/i
+const CALLOUT_TONES = new Set<CalloutTone>(['note', 'tip', 'important', 'warning', 'caution'])
 
 const CALLOUT_LABELS: Record<CalloutTone, string> = {
   note: 'Note',
@@ -43,42 +44,51 @@ function getMeaningfulChildren(children: ReactNode): ReactNode[] {
 
 function stripMarkerFromChildren(children: ReactNode): ReactNode {
   const items = getMeaningfulChildren(children)
+  const strippedItems: ReactNode[] = []
 
-  return items.map(async (item, index) => {
+  for (const [index, item] of items.entries()) {
     if (index !== 0) {
-      return item
+      strippedItems.push(item)
+      continue
     }
 
     if (typeof item === 'string') {
-      return item.replace(CALLOUT_PATTERN, '')
+      strippedItems.push(item.replace(CALLOUT_PATTERN, ''))
+      continue
     }
 
     if (!isValidElement(item)) {
-      return item
+      strippedItems.push(item)
+      continue
     }
 
     const element = item as ReactElement<{children?: ReactNode}>
     const text = extractText(element.props.children)
 
     if (!CALLOUT_PATTERN.test(text)) {
-      return item
+      strippedItems.push(item)
+      continue
     }
 
-    return cloneElement(element, {
+    strippedItems.push(cloneElement(element, {
       ...element.props,
       children: text.replace(CALLOUT_PATTERN, '')
-    })
-  })
+    }))
+  }
+
+  return strippedItems
+}
+
+function isCalloutTone(value: string | undefined): value is CalloutTone {
+  return value != null && CALLOUT_TONES.has(value as CalloutTone)
 }
 
 function resolveCalloutTone(children: ReactNode): CalloutTone | null {
   const firstChild = getMeaningfulChildren(children)[0]
   const firstText = extractText(firstChild).trimStart()
   const matched = CALLOUT_PATTERN.exec(firstText)?.[1]?.toLowerCase()
 
-  if (
-    new Set(['note', 'tip', 'important', 'warning', 'caution']).has(matched)
-  ) {
+  if (isCalloutTone(matched)) {
     return matched
   }
 

doc/components/home-contributors.tsx

@@ -61,14 +61,15 @@ function getRepoCoordinates(repoUrl: string) {
 
 function getGitHubHeaders() {
   const token = process.env.GITHUB_TOKEN ?? process.env.GH_TOKEN
-  const authorization = token != null && token !== ''
-    ? {Authorization: `Bearer ${token}`}
-    : {}
+  const headers: Record<string, string> = {
+    Accept: 'application/vnd.github+json'
+  }
 
-  return {
-    Accept: 'application/vnd.github+json',
-    ...authorization
+  if (token != null && token !== '') {
+    headers.Authorization = `Bearer ${token}`
   }
+
+  return headers
 }
 
 async function fetchContributorsPage(page: number): Promise<GitHubContributor[]> {

doc/package.json

@@ -12,7 +12,7 @@
     "postbuild": "pagefind --site .next/server/app --output-path public/_pagefind",
     "check": "run-p lint typecheck",
     "validate:content": "tsx scripts/validate-content.ts",
-    "typecheck": "next typegen && tsc --noEmit --incremental false",
+    "typecheck": "next typegen && tsc --project tsconfig.typecheck.json --noEmit --incremental false",
     "start": "next start",
     "lint": "pnpm run validate:content && eslint ."
   },

doc/tsconfig.json

@@ -33,8 +33,8 @@
     "**/*.tsx",
     "**/*.mdx",
     "**/_meta.ts",
-    ".next/types/**/*.ts",
-    ".next/dev/types/**/*.ts"
+    ".next/dev/types/**/*.ts",
+    ".next/types/**/*.ts"
   ],
   "exclude": [
     "node_modules"

doc/tsconfig.typecheck.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "next-env.d.ts",
+    "**/*.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    "**/*.mdx",
+    "**/_meta.ts",
+    ".next/dev/types/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    ".next/types/**/*.ts"
+  ]
+}

doc/vercel.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://openapi.vercel.sh/vercel.json",
+  "git": {
+    "deploymentEnabled": false
+  }
+}