Layout fixes

Cleanup
Merge branch 'main' into ai-page-summaries
2026-09-25 11:52:10 +00:00 · 2025-05-07 12:56:08 +02:00 · 2025-05-06 21:04:31 +02:00 · 2025-05-06 20:56:40 +02:00 · 2025-05-06 20:55:48 +02:00 · 2025-05-06 20:52:39 +02:00
561 changed files with 11727 additions and 12387 deletions
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix UX issue about highlighting the search term in search result sections
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Fix images in reusable content across spaces.
@@ -1,9 +0,0 @@
---
-gitbook: patch
---
-
-Fix three small visual issues
-
- Fix sidebar showing on `no-toc` pages in the gradient theme
- Fix variant selector truncating incorrectly in header when sections are present
- Fix page cover alignment on `lg` screens without TOC
@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix openapi-select hover in responses
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Respect fullWidth and defaultWidth for images
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Hide scrollbar on sections
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Add docs.testgitbook.com to ADAPTIVE_CONTENT_HOSTS list
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-fix nested a tag causing hydration error
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-fix href being empty in TOC
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix navigation between sections/variants when previewing a site in v2
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Add support for inline icons.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix revision id for computed content
@@ -0,0 +1,5 @@
+---
+"@gitbook/colors": patch
+---
+
+Update chroma ratio per step
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Add circular corners and depth styling
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix crash when integration script fails to render block.
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': patch
---
-
-Add authorization header for OAuth2
@@ -1,5 +0,0 @@
---
-"gitbook": minor
---
-
-Display MCP tool calls in AI chat.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Adds Columns layout block to GBO
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Support dark-mode specific page cover image
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Update Models page styling
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Show scrollbars
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Optimize performances by using a smarter per-request cache arround data cached functions
@@ -3,4 +3,4 @@
 'gitbook': patch
 ---

-Handle nullish OpenAPI mediaTypeObject
+Fix openapi CR preview
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-add a force-revalidate api route to force bust the cache in case of errors
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Add support for icons in buttons.
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Fix rendering of ogimage with SVG logos.
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Best effort at preserving current variant when navigating between sections by matching the pathname against site spaces in the new section.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix crash when integration is triggering invalid requests.
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Adds AI sidebar with recommendations based on browsing behaviour
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Optimize the fetch of revision files by using only the getRevision cache.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-encode customization header
@@ -0,0 +1,6 @@
+---
+"@gitbook/react-openapi": minor
+"gitbook": minor
+---
+
+Design tweaks to code blocks and OpenAPI pages
@@ -0,0 +1,8 @@
+---
+"@gitbook/react-openapi": patch
+"gitbook-v2": patch
+"gitbook": patch
+"@gitbook/colors": patch
+---
+
+Fix code highlighting for HTTP
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Rework full-width layout, add support for full-width page option
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix CodeBlock layout
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix resolution of links in reusable contents
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Scroll to active TOC when clicking a link
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-fix ISR on preview env
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Add support for text alignment for headings and paragraphs.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix concurrent execution in Vercel causing pages to not be attached to the proper tags.
@@ -1,5 +0,0 @@
---
-"@gitbook/react-contentkit": patch
---
-
-Add basic error handling when transitioning between states.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Generate a llms-full.txt version of the docs site
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Don't crash ogimage generation on RTL text, as a workaround until we can support it.
@@ -1,5 +0,0 @@
---
-gitbook: minor
---
-
-Add support for site customization option to change how external links open.
@@ -0,0 +1,6 @@
+---
+"gitbook-v2": minor
+"gitbook": minor
+---
+
+Add support for reusable content across spaces.
@@ -1,5 +0,0 @@
---
-"@gitbook/fonts": minor
---
-
-Initial version of the package
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix rendering of ogimage when logo or icon are AVIF images.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Add margin to adjacent buttons
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix ogimage generation failing with some JPEG images.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix invalid sitemap.xml generated with relative URLs instead of absolute ones
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix page group not expanded by default
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Don't cache unexpected API errors for more than a few minutes.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix an issue where PDF export URLs were not keeping their query params.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Change OpenAPI schema-optional from `info` to `tint` color
@@ -0,0 +1,5 @@
+---
+"@gitbook/colors": patch
+---
+
+Change lightness check for color step 9 to allow input colors with a higher-than-needed contrast
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix markdown page generation for groups
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-add a global error boundary
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix links to other spaces within a section.
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': patch
---
-
-Indent JSON python code sample
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add support for cover repositioning
@@ -3,4 +3,4 @@
 'gitbook': patch
 ---

-Improve support for OAuth2 security type
+Fix schemas disclosure label causing client error
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix missing title on button to close the announcement banner.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Make icons for page groups more contrasting
@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Missing top-level required OpenAPI alternatives
@@ -1,5 +0,0 @@
---
-"gitbook": minor
---
-
-Add AI chat
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Ignore case while highlighting search results.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Consistently show variant selector in section bar if site has sections
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Include page group children under the .md route
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Make TOC height dynamic based on visible header and footer elements
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Clicking an active TOC item toggles its descendants
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix viewing a page from a revision
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Improve error messages around undefined site sections.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix InlineLinkTooltip having a negative impact on performance, especially on larger pages.
@@ -1,6 +0,0 @@
---
-'@gitbook/openapi-parser': patch
-'@gitbook/react-openapi': patch
---
-
-Optional label in OpenAPI x-codeSamples
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix bold header links hover color
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-cache fonts and static image used in OGImage in memory
@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Increase logging around caching behaviour causing page crashes.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix border being added to cards
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Add metadata for adding site to Apple devices home
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': patch
---
-
-Handle nested deprecated properties in generateSchemaExample
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix crash during rendering of ogimage for VA sites with default icon.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Add `urlObject.hash` to `linker.toLinkForContent` to pass through URL fragment identifiers, used in search
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Allow to zoom images on mobile if relevant
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-apply customization for dynamic context
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Reverse order of feedback smileys
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Change `Dropdown`s to use Radix's `DropdownMenu`
@@ -0,0 +1,5 @@
+---
+"@gitbook/react-openapi": patch
+---
+
+Fix Python code sample "null vs None"
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Add border to filled sidebar on gradient theme
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': patch
---
-
-Deduplicate path parameters from OpenAPI spec
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-Fix ogimage using incorrect Google Font depending on language.
@@ -1,5 +0,0 @@
---
-gitbook: patch
---
-
-remove trailing slash from linker
@@ -0,0 +1,6 @@
+---
+"gitbook": patch
+"gitbook-v2": patch
+---
+
+Revert investigation work around URL caches.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix OpenAPI disclosure label ("Show properties") misalignment on mobile
@@ -1,3 +0,0 @@
-# Changes to the API data cache functions can invalidate all existing data cache
-# causing a massive amount of revalidation, impacting our API.
-packages/gitbook/src/lib/data/api.ts   @SamyPesse
@@ -53,42 +53,19 @@ After forking this repository, you'll want to [create a branch](https://docs.git

 #### 3. Install dependencies and run the project locally

-##### Prerequisites:
- Node.js (Version: >=20.6)
-  - Use `nvm` for easy Node management
- [Bun](https://bun.sh/) (Version: >=1.2.15)
-  - We use a text-based lockfile which isn't supported below 1.2.15
+GitBook uses [Bun](https://bun.sh/) to run the project. Make sure you're using the specified version of `node` before running any of the development commands to ensure a smooth development experience.

-##### Setup steps:
+You can easily do this by running the command `nvm use`.

-1. Ensure you are using the project's version of Node:
-```bash
-nvm use
-```
-
-2. Install dependencies using Bun:
-```bash
-bun install
-```
-
-3. Start the development server:
-```bash
-bun dev
-```
-
-Additional development commands:
- `bun format`: Format the code using Biome
- `bun typecheck`: Run TypeScript type checking
- `bun unit`: Run unit tests
- `bun e2e`: Run end-to-end tests
+To start your local version of GitBook, run the command `bun dev`.

 #### 4. Preview your changes

-When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/url`.
+When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.

-For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/url/gitbook.com/docs` after running the development server.
+For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/docs.gitbook.com` after running the development server.

-You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
+You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://docs.gitbook.com/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.

 ### Commit your update

@@ -1,83 +0,0 @@
-name: Gradual Deploy to Cloudflare
-description: Use gradual deployment to deploy to Cloudflare. This action will upload the middleware and server versions to Cloudflare and kept them bound together
-inputs:
-  apiToken:
-    description: 'Cloudflare API token'
-    required: true
-  accountId:
-    description: 'Cloudflare account ID'
-    required: true
-  environment:
-    description: 'Cloudflare environment to deploy to (staging, production, preview)'
-    required: true
-  middlewareVersionId:
-    description: 'Middleware version ID to deploy'
-    required: true
-  serverVersionId:
-    description: 'Server version ID to deploy'
-    required: true
-outputs:
-  deployment-url: 
-    description: "Deployment URL"
-    value: ${{ steps.deploy_middleware.outputs.deployment-url }}
-runs:
-  using: 'composite'
-  steps:
-      - id: wrangler_status
-        name: Check wrangler deployment status
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.10.0'
-            environment: ${{ inputs.environment }}
-            command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-      # This step is used to get the version ID that is currently deployed to Cloudflare.
-      - id: extract_current_version
-        name: Extract current version
-        shell: bash
-        run: |
-          version_id=$(echo "${{ steps.wrangler_status.outputs.command-output }}" | grep -A 3 "(100%)" | grep -oP '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
-          echo "version_id=$version_id" >> $GITHUB_OUTPUT
-
-      - id: deploy_server
-        name: Deploy server to Cloudflare at 0%
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.10.0'
-            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-      # Since we use version overrides headers, we can directly deploy the middleware to 100%.
-      - id: deploy_middleware
-        name: Deploy middleware to Cloudflare at 100%
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.10.0'
-            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
-
-      - name: Deploy server to Cloudflare at 100%
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.10.0'
-            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-      - name: Outputs
-        shell: bash
-        env:
-          DEPLOYMENT_URL: ${{ steps.deploy_middleware.outputs.deployment-url }}
-        run: |
-            echo "URL: ${{ steps.deploy_middleware.outputs.deployment-url }}"
@@ -28,7 +28,7 @@ inputs:
 outputs:
    deployment-url: 
      description: "Deployment URL"
-      value: ${{ steps.upload_middleware.outputs.deployment-url }}
+      value: ${{ steps.deploy.outputs.deployment-url }}
 runs:
    using: 'composite'
    steps:
@@ -59,12 +59,12 @@ runs:
            GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
        - name: Build worker
-          run: bun run turbo build:cloudflare
+          run: bun run turbo build:v2:cloudflare
          env:
            GITBOOK_RUNTIME: cloudflare
          shell: bash
-
-        - name: Upload the DO worker
+        - id: deploy
+          name: Deploy to Cloudflare
          uses: cloudflare/wrangler-action@v3.14.0
          with:
              apiToken: ${{ inputs.apiToken }}
@@ -72,67 +72,10 @@ runs:
              workingDirectory: ./
              wranglerVersion: '4.10.0'
              environment: ${{ inputs.environment }}
-              command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
-
-        - id: upload_server
-          name: Upload server to Cloudflare
-          uses: cloudflare/wrangler-action@v3.14.0
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              workingDirectory: ./
-              wranglerVersion: '4.10.0'
-              environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-        - name: Extract server version worker ID
-          shell: bash
-          id: extract_server_version_id
-          run: |
-              version_id=$(echo '${{ steps.upload_server.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
-              echo "version_id=$version_id" >> $GITHUB_OUTPUT
-
-        - name: Run updateWrangler scripts
-          shell: bash
-          run: |
-              bun run ./packages/gitbook/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
-
-        - id: upload_middleware
-          name: Upload middleware to Cloudflare
-          uses: cloudflare/wrangler-action@v3.14.0
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              workingDirectory: ./
-              wranglerVersion: '4.10.0'
-              environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
-        
-        - name: Extract middleware version worker ID
-          shell: bash
-          id: extract_middleware_version_id
-          run: |
-              version_id=$(echo '${{ steps.upload_middleware.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
-              echo "version_id=$version_id" >> $GITHUB_OUTPUT
-
-        - name: Deploy server and middleware to Cloudflare
-          if: ${{ inputs.deploy == 'true' }}
-          uses: ./.github/actions/gradual-deploy-cloudflare
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              opServiceAccount: ${{ inputs.opServiceAccount }}
-              opItem: ${{ inputs.opItem }}
-              environment: ${{ inputs.environment }}
-              serverVersionId: ${{ steps.extract_server_version_id.outputs.version_id }}
-              middlewareVersionId: ${{ steps.extract_middleware_version_id.outputs.version_id }}
-              deploy: ${{ inputs.deploy }}
-
-
+              command: ${{ inputs.deploy == 'true' && 'deploy' || format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/wrangler.jsonc
        - name: Outputs
          shell: bash
          env:
-            DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
+            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
          run: |
-              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
-              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
@@ -7,6 +7,53 @@ on:
 env:
    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
+    deploy-v1-cloudflare:
+        name: Deploy v1 to Cloudflare Pages
+        runs-on: ubuntu-latest
+        environment:
+          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Sets env vars for production
+              if: github.ref == 'refs/heads/main'
+              run: |
+                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+            - name: Build Next.js with next-on-pages
+              run: bun run turbo gitbook#build:cloudflare
+              env:
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  GITBOOK_RUNTIME: cloudflare
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.14.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.112.0'
+                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
    deploy-v2-vercel:
        name: Deploy v2 to Vercel (preview)
        runs-on: ubuntu-latest
@@ -67,6 +114,7 @@ jobs:
        name: Comment Deployments (preview)
        if: always() && !startsWith(github.ref, 'refs/heads/main')
        needs:
+            - deploy-v1-cloudflare
            - deploy-v2-vercel
            - deploy-v2-cloudflare
        steps:
@@ -86,6 +134,15 @@ jobs:
                  body: |
                      Summary of the deployments:

+                      ### Version 1
+
+                      | Version | URL | Status |
+                      | --- | --- | --- |
+                      | Latest commit | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
+                      | PR | [${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
+
+                      ### Version 2
+
                      | Version | URL | Status |
                      | --- | --- | --- |
                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
@@ -93,11 +150,30 @@ jobs:

                      ### Test content

-                      | Site | `2v` | `2c` |
-                      | --- | --- | --- |
-                      | GitBook | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) |
-                      | E2E | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
+                      | Site | `v1` | `2v` | `2c` |
+                      | --- | --- | --- | --- |
+                      | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com) |
+                      | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
                  edit-mode: replace
+    visual-testing-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
    visual-testing-v2-vercel:
        runs-on: ubuntu-latest
        name: Visual Testing v2
@@ -124,6 +200,7 @@ jobs:
        name: Visual Testing v2 (Cloudflare)
        needs: deploy-v2-cloudflare
        timeout-minutes: 10
+        if: startsWith(github.head_ref || github.ref_name, 'cloudflare/') || github.ref == 'refs/heads/main'
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -140,11 +217,31 @@ jobs:
                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                  ARGOS_BUILD_NAME: 'v2-cloudflare'
+    visual-testing-customers-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v1'
    visual-testing-customers-v2:
        runs-on: ubuntu-latest
        name: Visual Testing Customers v2
        needs: deploy-v2-vercel
-        timeout-minutes: 10
+        timeout-minutes: 8
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -165,7 +262,8 @@ jobs:
        runs-on: ubuntu-latest
        name: Visual Testing Customers v2 (Cloudflare)
        needs: deploy-v2-cloudflare
-        timeout-minutes: 10
+        timeout-minutes: 8
+        if: startsWith(github.head_ref || github.ref_name, 'cloudflare/') || github.ref == 'refs/heads/main'
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -182,10 +280,10 @@ jobs:
                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                  ARGOS_BUILD_NAME: 'customers-v2'
-    pagespeed-testing-v2:
+    pagespeed-testing-v1:
        runs-on: ubuntu-latest
        name: PageSpeed Testing v1
-        needs: deploy-v2-vercel
+        needs: deploy-v1-cloudflare
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -198,5 +296,5 @@ jobs:
            - name: Run pagespeed tests
              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
              env:
-                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
+                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
@@ -39,4 +39,22 @@ jobs:
                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-
+    release-preview:
+        # For now it releases the cache-do to both preview and production
+        # Once we changed to deploy the app only on release, we should change `release:preview` in `cache-do`
+        name: Release Preview
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v3
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Release preview packages
+              run: bun run release:preview
+              env:
+                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
@@ -1,7 +1,7 @@
 <h1 align="center">GitBook</h1>

 <p align="center">
-  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> - <a href="https://github.com/orgs/GitbookIO/discussions/categories/feature-requests">Feature requests</a> 
+  <a href="https://docs.gitbook.com/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> 
 </p>

 <p align="center">
@@ -36,9 +36,9 @@ To run a local version of this project, please follow these simple steps.
 ### Prerequisites

 -   Node.js (Version: >=20.6)
-    - Use nvm for easy Node management
+  - Use nvm for easy Node management
 -   Bun (Version: >=1.2.1)
-    - We use a text-based lockfile which isn't supported below 1.2.1
+  - We use a text-based lockfile which isn't supported below 1.2.1

 ### Set up

@@ -59,18 +59,23 @@ bun install
 4. Start your local development server.

 ```
-bun dev
+bun dev:v2
 ```

-6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.
+5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.

 examples:

-   http://localhost:3000/url/gitbook.com/docs
+-   http://localhost:3000/url/docs.gitbook.com
 -   http://localhost:3000/url/open-source.gitbook.io/midjourney

 Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.

+### Other development commands
+
+-   `bun format`: format the code
+-   `bun lint`: lint the code
+
 ### CI and testing

 All pull-requests will be tested against both visual and performances testing to prevent regressions.
@@ -145,11 +150,11 @@ See `LICENSE` for more information.
 </p>

 ```md
-[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link)
+[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://gitbook.com/)
 ```

 ```html
-<a href="https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link">
+<a href="https://gitbook.com">
    <img
        src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"
    />
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Zeno Kapitein	c38d403f77	Layout fixes	2025-05-07 12:56:08 +02:00
Zeno Kapitein	c3bde7d989	Cleanup	2025-05-06 21:04:31 +02:00
Zeno Kapitein	8a08b0f366	Merge branch 'main' into ai-page-summaries	2025-05-06 20:56:40 +02:00
Zeno Kapitein	ed17c11715	Turn of tools (for now)	2025-05-06 20:55:48 +02:00
Zeno Kapitein	6ce3f4b17a	Tweaks	2025-05-06 20:52:39 +02:00
Zeno Kapitein	fb9c8f4d2c	Second pass	2025-05-06 20:35:26 +02:00
Zeno Kapitein	fbf6951c71	First pass	2025-05-06 16:55:06 +02:00
Zeno Kapitein	d8cfb10974	Format	2025-05-01 10:49:32 +02:00
Zeno Kapitein	3cdba0ae8e	Cleanup & format	2025-05-01 10:49:32 +02:00
Zeno Kapitein	83e02b621a	Iteration 4	2025-05-01 10:49:32 +02:00
Zeno Kapitein	cb2cc52c26	Third iteration	2025-05-01 10:49:32 +02:00
Zeno Kapitein	0e15229c52	Second iteration	2025-05-01 10:49:32 +02:00
Zeno Kapitein	8547867c6d	Initial version	2025-05-01 10:49:32 +02:00