Fix variant dropdown for sites without variants

.agents/skills/write-pr-description/SKILL.md

@@ -1,48 +0,0 @@
----
-name: write-pr-description
-description: Write a concise, product-focused PR description from the changes and available discussion. Use when asked for a PR summary or description.
----
-
-# Write a PR description
-
-Read the full branch diff and commit history against the PR's base branch, not just the latest commit. Use the PR discussion and linked issues for context when available. The PR's changes are the source of truth for what ships if an issue describes something different.
-
-Write for contributors and reviewers who may not know the area. Lead with what changes, prefer user or product impact when supported, and include implementation details only when they help review. Keep the proposed changes short, using bullets only when useful.
-
-Include relevant validation and screenshots when available. Do not claim checks passed unless they ran. Use only information appropriate for a public repository; do not copy private issue details or customer information into the description.
-
-## Template and changelog
-
-Read `.github/pull_request_template.md` immediately before writing. Preserve its required section names and order. Include `Proposed changes` and `Changelog`; omit `Demo` when there is nothing to show. Add optional `Context` before `Changelog` only when it meets the rule below.
-
-Write a short changelog entry describing what shipped. Use `[Feature]` for user-facing additions or improvements, `[Fix]` for user-facing bug fixes, and `[Chore]` for internal maintenance. For features and fixes, say what users can do or what no longer goes wrong in plain words. Keep chores useful to teammates without inventing user impact. Remove unused examples and placeholders. Usually one entry is enough; use more only for distinct changes. The PR changelog does not replace any changeset required by `AGENTS.md`.
-
-## Optional context
-
-Write `Proposed changes` and `Changelog` first. Add `Context` only when it tells someone unfamiliar with the area something material that the changelog does not. `Problem` names a concrete failure or limitation supported by the PR or discussion. `Outcome` names what this PR delivers at its actual scope. Omit the section if either field would repeat the changelog, describe only implementation, or guess at an impact.
-
-```markdown
-## Context
-
-**Problem:** <concrete failure or limitation>
-
-**Outcome:** <result delivered by this PR>
-```
-
-Keep each field to 1–2 short, non-technical sentences. Prefer user or product impact when supported. For infrastructure changes, explain the failure or limitation they caused. Do not invent an actor, customer segment, ownership, or impact, or force the change into a user story. Do not turn a preparatory change into a claim that the whole workflow is fixed. Keep the roles distinct: `Context` explains why this matters, `Changelog` says what shipped, and `Proposed changes` can explain implementation.
-
-Examples:
-
-- A dependency bump with no demonstrated user effect needs no `Context`.
-- If creating the first change request leaves the user on an empty screen, say that it now opens after creation. Leave the animation-listener details in `Proposed changes`.
-- If a PR indexes links for later checks, describe the indexing result. Do not claim every link has already been checked.
-
-## Writing pass
-
-- Use plain words and direct verbs: "use" instead of "leverage", "help" instead of "facilitate". Prefer active voice when the actor is known.
-- Name the concrete behavior instead of saying "improves the experience" or "makes it more robust". Support performance claims with measurements.
-- Cut filler, promotional language, and generic conclusions. If a sentence could fit almost any PR, make it specific or delete it.
-- Keep one idea per sentence and use consistent names. Remove redundant hedging without hiding real uncertainty.
-- Avoid "not just X, but Y", forced groups of three, em dashes, decorative emojis, and unnecessary bold text.
-
-Return the description in a Markdown code block unless asked to update the PR. When asked to update it, apply the description with `gh pr edit` using a body file.

.changeset/beige-crabs-attack.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Avoid multiple <h1> in the page by using a <div> for the title in the header

.changeset/beige-snails-count.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Adds content-visibility css property to OpenAPI Operation for better render performance

.changeset/big-chicken-poke.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/cache-do': minor
+---
+
+Experiment with optimizing billable duration in Cloudflare by using multiple RPC sessions instead of one

.changeset/blue-wasps-sparkle.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix scroll position when navigating pages on mobile

.changeset/brave-camels-trade.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add Python support in Code Samples

.changeset/bright-cars-explain.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Add automatic color contrast in site header, restyle search button

.changeset/bump-next-16-4-3.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Bump Next.js to 16.4.3, keeping the dev-mode OOM patch.

.changeset/clean-balloons-travel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+RND-3532: drop down menu for hidden links at small screen size

.changeset/cold-knives-judge.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Change dark mode shadow for multi-space search toolbar

.changeset/dull-gifts-flow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Use ellipsis and fix icon color for more links in the header on small screen

.changeset/eighty-owls-type.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve consistency of change request preview by removing cache-control on response

.changeset/fast-timers-sniff.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': patch
+---
+
+Update version for static assets to fix invalid caching

.changeset/fluffy-peas-tie.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Revalidate change request cached content when pressing refresh button

.changeset/forty-trains-pull.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': patch
+---
+
+Fix first run of the package in development mode

.changeset/funny-avocados-tickle.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add navigation tabs for sections

.changeset/gentle-oranges-nail.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve performances of loading pages with embeds by caching them

.changeset/green-swans-boil.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+bump: scalar from 1.0.5 to 1.0.7

.changeset/grumpy-humans-yawn.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Support resolution of new site URLs with sections

.changeset/healthy-spoons-itch.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Replace all icons, previously imported from Geist, by new package `@gitbook/icons`

.changeset/heavy-jeans-unite.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/cache-do': minor
+---
+
+First version of a new cache backend powered by Cloudflare Durable Objects

.changeset/honest-jars-refuse.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for Norwegian language

.changeset/hungry-actors-march.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)

.changeset/hungry-students-sing.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for page icons

.changeset/khaki-phones-jog.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix GitBook specific static assets not being served correctly when deployed on Cloudflare

.changeset/kind-flies-impress.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Only display spaces dropdown in compact header when site is multi-variants

.changeset/light-candles-trade.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport

.changeset/light-pots-dress.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/cache-do': patch
+---
+
+Enable Workers observability with a sampling of 0.1

.changeset/llms-full-size-pagination.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Split llms-full.txt into parts by size so large sites no longer fail with "content too large"

.changeset/lovely-donkeys-deny.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': minor
+---
+
+Initial release for `@gitbook/icons`, a package of content icons to be used for pages, documents, etc.

.changeset/lovely-hats-peel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Automatically scroll to active item in TOC

.changeset/lovely-lies-complain.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for searching results in a sections site

.changeset/mcp-get-page-redirects.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Follow site and space redirects when the MCP getPage tool resolves a page URL.

.changeset/mighty-apples-design.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Persist state of tabs and dynamically sync them based on title

.changeset/native-external-link-clicks.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Let analytics tools like GA4 track outbound link clicks by using native link navigation.

.changeset/nervous-turtles-lick.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Ensure "Sponsored via GitBook" can be translated in all languages

.changeset/nice-waves-compare.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update ogimage with new design

.changeset/nine-maps-judge.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Show the caption for file blocks

.changeset/ninety-starfishes-refuse.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Use url hash to open Expandable and scroll to anchor

.changeset/odd-beds-walk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix margin for paragraphs in quote blocks

.changeset/odd-candles-cover.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).

.changeset/pink-feet-bake.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Include offset in calculations of whether scrollable element is in view

.changeset/plenty-pets-hope.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add required query parameters to the code sample

.changeset/poor-bats-cheer.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Display pattern if available in parmas in OpenAPI block

.changeset/poor-emus-remember.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix inconsistent click area in table because of scroll indicator

.changeset/popular-toys-argue.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Stop using KV cache backend for now, but also improves it for higher performances

.changeset/purple-forks-refuse.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': minor
+'gitbook': patch
+---
+
+Synchronize response and response example tabs

.changeset/purple-lies-teach.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Show definition title when visible in cards

.changeset/purple-pugs-attend.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix flickering when displaying an "Ask" answer with code blocks

.changeset/quiet-doors-double.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': minor
+'gitbook': patch
+---
+
+Rollback of scalar modal while fixing perf issue

.changeset/rare-maps-call.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Optimize images rendered in community ads

.changeset/rare-plants-listen.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update design of Checkbox to be more consistent and readable

.changeset/red-bats-chew.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-contentkit': patch
+---
+
+Fix rendering of webframe with SSR causing wrong communication between frame and renderer

.changeset/resolve-full-url.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Resolve the published content with the full URL in a single lookup and always send the visitor country.

.changeset/rss-feed-html-content.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Keep lists, paragraphs and code blocks as HTML in Updates RSS feeds, instead of running all the text together

.changeset/shiny-boats-push.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency

.changeset/shy-buttons-relate.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations

.changeset/silent-donuts-love.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Fix crash when `example` is undefined for a response

.changeset/sixty-paws-share.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Improve the toolbar for change-requests and revisions to show more actions

.changeset/slimy-rules-think.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Added support for new Reusable Content block.

.changeset/smooth-moose-marry.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for icons style customization for sites

.changeset/strange-eyes-notice.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Adds tabs to Response Example section e.g. for status code examples

.changeset/ten-carpets-cover.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Render mandatory headers in code sample

.changeset/tender-onions-jog.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Update Scalar client to latest version

.changeset/thick-dogs-bake.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Prevent search indexation for pages where it's configured as disabled

.changeset/three-shoes-talk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix table of contents being visible on mobile when disabled at the page level

.changeset/tricky-hounds-smoke.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`

.changeset/unlucky-balloons-explain.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Update rendering of community ads to match new API response, and make it possible to preview ads.

.changeset/violet-beers-matter.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-math': minor
+---
+
+Export binary `gitbook-math` to copy assets to a directory

.changeset/weak-hairs-compete.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix "ip" being passed to BSA for community ads

.changeset/wet-houses-grab.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improving the look and feel of new section tabs

.changeset/wicked-bees-change.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix

.changeset/wild-worms-roll.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': minor
+---
+
+Fix bin gitbook-icons when installed without the Pro token

.changeset/wise-papayas-retire.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Don't show hidden pages in the empty state of a page

.changeset/witty-kiwis-knock.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix linking to a tab itself

.changeset/young-mails-itch.md

@@ -0,0 +1,9 @@
+---
+'gitbook': patch
+---
+
+Update header styling of sections, variant selector, and button links
+
+-   Change position of variant selector depending on context (next to logo or in table of contents)
+-   Update section tab styling and animation
+-   Make header buttons smaller with a new `medium` button size

.claude/launch.json

@@ -1,12 +0,0 @@
-{
-    "version": "0.0.1",
-    "configurations": [
-        {
-            "name": "🚀 Dev server",
-            "runtimeExecutable": "sh",
-            "runtimeArgs": ["-c", "bun install && bun dev"],
-            "port": 3000,
-            "autoPort": false
-        }
-    ]
-}

.claude/skills/write-pr-description

@@ -1 +0,0 @@
-../../.agents/skills/write-pr-description

.codex/skills/write-pr-description

@@ -1 +0,0 @@
-../../.agents/skills/write-pr-description

.editorconfig

@@ -1,10 +0,0 @@
-# Stop editors from looking for .editorconfig files in parent directories.
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_style = space
-indent_size = 4
-insert_final_newline = true
-max_line_length = 100

.github/CONTRIBUTING.md

@@ -1,89 +1,88 @@
-# Contributing to GitBook
+# Welcome to GitBook's contributing guide!
 
-> _For help, support and product questions, head to our [GitHub Community](https://github.com/orgs/GitbookIO/discussions)._
+> _For help, support, feature requests, and product questions - head to our [GitHub Community](https://github.com/orgs/GitbookIO/discussions) 🤖_
 
-Thanks for helping make GitBook better. This repository holds the open source renderer behind every published GitBook site, and the team reads everything that comes in here.
+Thank you for investing your time in contributing to GitBook. Any contribution you make will be reviewed by our team. In this guide, you'll learn the different ways you can contribute.
 
-## Ways to contribute
+## Types of Contributions
 
--   **Open an issue.** Report a bug, suggest a feature, or tell us when something feels off. This is the most useful thing you can do.
--   **Join the conversation.** Share ideas and help others in [GitHub Community](https://github.com/orgs/GitbookIO/discussions).
--   **Build with GitBook.** Publish your docs, try new features early, and tell us what works and what doesn't.
+This repository contains code related to the rendering engine of GitBook's published content. Depending on what you'd like to contribute to, head to the section below to find the necessary steps.
 
-## Issues instead of pull requests
+### Add a feature
 
-Pull requests are limited to the GitBook team. If you've found a bug or want something to change, please [open an issue](https://github.com/GitbookIO/gitbook/issues/new/choose) instead.
+Because this portion of GitBook is open source and available for you to use - if you think you can provide extra value through a new feature - you're welcome to add it! If you plan to distribute the code, keep the source code public to comply with GNU GPLv3. To clone in a private repository, you must first acquire a [commercial license](https://www.gitbook.com/pricing).
 
-This isn't because we don't want your help. Every change here ships to every published GitBook site, so we need to own each one from start to finish. A clear issue often helps us more than a pull request: it tells us what's wrong and why, and lets us fix it in a way that fits the rest of the codebase.
+### Create a new issue
 
-A good issue includes:
+If you spot a problem within a repository, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue here!Please make sure any added issues are
 
--   What you expected to happen, and what happened instead
--   A link to a published GitBook site that shows the problem, if you have one
--   Steps to reproduce it, plus screenshots or a recording for anything visual
--   Your browser and OS, if it looks like it might matter
+-   Descriptive
+-   Thoughtful
+-   Organized
 
-Before opening one, [search existing issues](https://github.com/GitbookIO/gitbook/issues). If someone has already reported it, add a 👍 or any extra details you have.
+We recommend adding as many relevant links, minimal reproductions of the issue, and other materials that will help our team solve the issue fast.
 
-Already fixed it in your fork? Link the branch or commit in your issue. We may open a pull request from it, and your commits keep your name.
+### Solve an issue
 
-If you open a pull request anyway, we'll close it and point you here. Nothing personal, and we'd still love the issue.
+If you're interested in solving an issue in our repository, start by scanning through it's exisiting issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix. See the following sections below for more information on contributing for specific sections.
 
-## Reach out
+### Documentation
 
-Not sure if it's a bug? Have a half-formed idea? Open an issue or start a [discussion](https://github.com/orgs/GitbookIO/discussions) anyway. We'd much rather hear from you than not, and no report is too small.
+The official documentation on GitBook open can be found directly in this Readme. Any updates or changes you would like to make, you can make directly to the README of this repository.
 
-Spotted a wrong or missing translation? Open an issue with the string and the wording you'd suggest.
+## Contributing
 
-## Using AI
+### Make changes locally
 
-You're welcome to use AI to help you write an issue. Please read and check what it produces before you post: reports that are long, vague or unverified take time away from fixing real problems, and we may close them without a reply.
+Any contribution you make can be made to the code located in this repository. In order to contribute, you'll need to start off of a local version of this repository.
 
-## Running locally
+#### 1. Fork the repository
 
-You don't need a local setup to open an issue, but it can help you reproduce a problem or self-host the renderer.
+##### Using GitHub Desktop:
 
-### Prerequisites
+-   [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
+-   Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
 
--   [Node.js](https://nodejs.org/en) (see "engines" in `package.json`)
--   [Bun](https://bun.sh/) (see "packageManager" in `package.json`)
+##### Using the command line:
 
-### Setup
+-   [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
 
-1. Use the project's version of Node:
+#### 2. Create a working branch and start with your changes
 
-```bash
-nvm use
-```
+After forking this repository, you'll want to [create a branch](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue) to work off of.
 
-2. Install dependencies:
+#### 3. Install dependencies and run the project locally
 
-```bash
-bun install
-```
+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.
 
-3. Start the development server:
+You can easily do this by running the command `nvm use`.
 
-```bash
-bun dev
-```
+To start your local version of GitBook, run the command `bun dev`.
 
-Other commands:
+#### 4. Preview your changes
 
--   `bun lint`: Lint the code using Oxlint
--   `bun lint:fix`: Automatically fix lint issues using Oxlint
--   `bun format`: Format the code using Oxfmt
--   `bun format:check`: Check formatting without changing files
--   `bun typecheck`: Run TypeScript type checking
--   `bun unit`: Run unit tests
--   `bun e2e`: Run end-to-end tests
+When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.
 
-### Preview a site
+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.
 
-With the development server running, any published GitBook site can be rendered through your local version at `http://localhost:3000/url/<published-url>`. For example, visit `http://localhost:3000/url/gitbook.com/docs` to see our own docs.
+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.
 
-The site must be [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to render locally.
+### Commit your update
 
-## License
+[Commit your changes](https://github.com/git-guides/git-commit) once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages!
 
-The renderer is distributed under the [GNU GPLv3 License](https://github.com/GitbookIO/gitbook/blob/main/LICENSE). If you distribute the code, you must keep the source code public. To use it in a private repository, you need a [commercial license](https://www.gitbook.com/pricing).
+Once your changes are ready, don't forget to self-review your code to double check that your chagnes are ready to be added.
+
+### Pull Request
+
+When you're finished with the changes, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request), also known as a PR.
+
+-   Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
+-   Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. Once you submit your PR, a GitBook team member will review your proposal. We may ask questions or request for additional information.
+-   We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+-   As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+-   If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Your PR is merged
+
+Congratulations 🎉 Thank you for your contribution! Once your PR is merged, your contributions will be publicly visible on the relevant repository.

.github/actions/gradual-deploy-cloudflare/action.yaml

@@ -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.43.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.43.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.43.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.43.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 }}"

.github/actions/setup-playwright/action.yml

@@ -0,0 +1,37 @@
+name: 'Setup Playwright'
+description: 'Install Playwright and dependencies'
+runs:
+    using: 'composite'
+    steps:
+        # Run npm ci and get Playwright version
+        - name: 🏗 Prepare Playwright env
+          shell: bash
+          run: |
+              PLAYWRIGHT_VERSION=$(npm ls --json @playwright/test | jq --raw-output '.dependencies["gitbook"].dependencies["@playwright/test"].version')
+              echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
+
+        # Cache browser binaries, cache key is based on Playwright version and OS
+        - name: 🧰 Cache Playwright browser binaries
+          uses: actions/cache@v3
+          id: playwright-cache
+          with:
+              path: '~/.cache/ms-playwright'
+              key: '${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}'
+              restore-keys: |
+                  ${{ runner.os }}-playwright-
+
+        # Install browser binaries & OS dependencies if cache missed
+        - name: 🏗 Install Playwright browser binaries & OS dependencies
+          if: steps.playwright-cache.outputs.cache-hit != 'true'
+          shell: bash
+          working-directory: packages/gitbook
+          run: |
+              bun x playwright install --with-deps chromium
+
+        # Install only the OS dependencies if cache hit
+        - name: 🏗 Install Playwright OS dependencies
+          if: steps.playwright-cache.outputs.cache-hit == 'true'
+          shell: bash
+          working-directory: packages/gitbook
+          run: |
+              bun x playwright install-deps

.github/composite/deploy-cloudflare/action.yaml

@@ -1,145 +0,0 @@
-name: 'Deploy cloudflare'
-description: 'Deploy GitBook to Cloudflare'
-inputs:
-    opItem:
-        description: '1Password item to load secrets from'
-        required: true
-    opServiceAccount:
-        description: '1Password service account token'
-        required: true
-    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
-    deploy:
-        description: 'Deploy as main version for all traffic instead of uploading versions'
-        required: true
-    commitTag:
-        description: 'Commit branch to associate with the deployment'
-        required: true
-    commitMessage:
-        description: 'Commit message to associate with the deployment'
-        required: true
-outputs:
-    deployment-url:
-        description: 'Deployment URL'
-        value: ${{ steps.upload_middleware.outputs.deployment-url }}
-runs:
-    using: 'composite'
-    steps:
-        - name: Setup Bun
-          uses: ./.github/composite/setup-bun
-        - name: Install dependencies
-          run: bun install --frozen-lockfile
-          shell: bash
-          env:
-              PUPPETEER_SKIP_DOWNLOAD: 1
-        - name: Load secret
-          uses: 1password/load-secrets-action@v2
-          env:
-              OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
-              GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
-              GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
-              GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
-              NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.opItem }}/NEXT_SERVER_ACTIONS_ENCRYPTION_KEY
-              GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
-              GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
-              GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
-              GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
-              GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
-              GITBOOK_OAUTH_SERVER_URL: ${{ inputs.opItem }}/GITBOOK_OAUTH_SERVER_URL
-              GITBOOK_SITE_OAUTH_SIGNING_SECRET: ${{ inputs.opItem }}/GITBOOK_SITE_OAUTH_SIGNING_SECRET
-              GITBOOK_PREVIEW_BASE_URL: ${{ inputs.opItem }}/GITBOOK_PREVIEW_BASE_URL
-              GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
-              GITBOOK_INTEGRATIONS_CONTENT_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_CONTENT_HOST
-              GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
-              GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL_2
-              GITBOOK_IMAGE_RESIZE_SALT: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SALT
-              GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
-              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
-          env:
-              GITBOOK_RUNTIME: cloudflare
-              GITBOOK_BLOCK_SEARCH_INDEXATION: ${{ inputs.environment == 'preview' && 'true' || '' }}
-              GITBOOK_ALLOW_CUSTOMIZATION_OVERRIDE: ${{ inputs.environment == 'preview' && 'true' || '' }}
-              GITBOOK_DISABLE_INSIGHTS: ${{ inputs.environment == 'preview' && 'true' || '' }}
-          shell: bash
-
-        - name: Upload the DO worker
-          uses: cloudflare/wrangler-action@v3.14.0
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              workingDirectory: ./
-              wranglerVersion: '4.43.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.43.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.43.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 }}
-
-        - name: Outputs
-          shell: bash
-          env:
-              DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
-          run: |
-              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
-              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"

.github/composite/deploy-vercel/action.yaml

@@ -1,101 +0,0 @@
-name: 'Deploy vercel'
-description: 'Deploy GitBook to Vercel'
-inputs:
-    vercelOrg:
-        description: 'Vercel organization'
-        required: true
-    vercelProject:
-        description: 'Vercel project'
-        required: true
-    vercelToken:
-        description: 'Vercel token'
-        required: true
-    opItem:
-        description: '1Password item to load secrets from'
-        required: true
-    opServiceAccount:
-        description: '1Password service account token'
-        required: true
-    environment:
-        description: 'Environment to deploy to'
-        required: true
-    headSha:
-        description: 'Git ref to deploy, used for the deploymentId'
-        required: false
-outputs:
-    deployment-url:
-        description: 'Deployment URL'
-        value: ${{ steps.deploy.outputs.deployment-url }}
-runs:
-    using: 'composite'
-    steps:
-        - name: Setup Bun
-          uses: ./.github/composite/setup-bun
-        - name: Install dependencies
-          run: bun install --frozen-lockfile
-          shell: bash
-          env:
-              PUPPETEER_SKIP_DOWNLOAD: 1
-        - name: Pull Vercel Environment Information
-          run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
-          shell: bash
-          env:
-              VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-              VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
-        - name: Load secret
-          uses: 1password/load-secrets-action@v2
-          env:
-              OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
-              GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
-              GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
-              GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
-              GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
-              GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
-              GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
-              GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
-              GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
-              GITBOOK_OAUTH_SERVER_URL: ${{ inputs.opItem }}/GITBOOK_OAUTH_SERVER_URL
-              GITBOOK_SITE_OAUTH_SIGNING_SECRET: ${{ inputs.opItem }}/GITBOOK_SITE_OAUTH_SIGNING_SECRET
-              GITBOOK_PREVIEW_BASE_URL: ${{ inputs.opItem }}/GITBOOK_PREVIEW_BASE_URL
-              GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
-              GITBOOK_INTEGRATIONS_CONTENT_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_CONTENT_HOST
-              GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
-              GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL_2
-              GITBOOK_IMAGE_RESIZE_SALT: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SALT
-              GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
-              GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
-              GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
-        - name: Inject build env vars
-          if: ${{ inputs.environment == 'preview' }}
-          shell: bash
-          run: |
-              HEAD_SHA=$(git rev-parse HEAD)
-              echo "resolved HEAD_SHA: $HEAD_SHA"
-              echo "GITBOOK_HEAD_SHA=$HEAD_SHA" >> .vercel/.env.${{ inputs.environment }}.local
-              echo "GITBOOK_RUNTIME=vercel" >> .vercel/.env.${{ inputs.environment }}.local
-              echo "GITBOOK_BLOCK_SEARCH_INDEXATION=true" >> .vercel/.env.${{ inputs.environment }}.local
-              echo "GITBOOK_ALLOW_CUSTOMIZATION_OVERRIDE=true" >> .vercel/.env.${{ inputs.environment }}.local
-              echo "GITBOOK_DISABLE_INSIGHTS=true" >> .vercel/.env.${{ inputs.environment }}.local
-              echo "--- .vercel/.env.${{ inputs.environment }}.local after inject ---"
-              cat .vercel/.env.${{ inputs.environment }}.local
-        - name: Build Project Artifacts
-          run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
-          shell: bash
-          env:
-              VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-              VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
-              GITBOOK_RUNTIME: vercel
-              GITBOOK_HEAD_SHA: ${{ inputs.headSha }}
-        - name: Deploy Project Artifacts to Vercel
-          id: deploy
-          shell: bash
-          run: |
-              DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }})
-              echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
-          env:
-              VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-              VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
-        - name: Outputs
-          shell: bash
-          run: |
-              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/composite/setup-bun/action.yaml

@@ -1,9 +0,0 @@
-name: 'Setup Bun'
-description: 'Install Bun and cache dependencies'
-runs:
-    using: 'composite'
-    steps:
-        - name: Setup bun
-          uses: oven-sh/setup-bun@v2
-          with:
-              bun-version-file: 'package.json'

.github/pull_request_template.md

@@ -1,17 +0,0 @@
-## Proposed changes
-
-<!-- Briefly describe what changed. Include relevant validation. -->
-
-## Demo
-
-<!-- Add screenshots or a recording when useful. Otherwise, remove this section. -->
-
-<!-- Optional: add Context here only when it explains a concrete problem and result that the changelog does not. Remove this comment before submitting. -->
-
-## Changelog
-
-<!-- Keep the relevant entries and remove unused placeholders. Feature = user-facing addition or improvement; Fix = user-facing bug fix; Chore = internal maintenance. -->
-
-- [Feature] ...
-- [Fix] ...
-- [Chore] ...

.github/slack-pr-status-app-manifest.json

@@ -1,22 +0,0 @@
-{
-    "display_information": {
-        "name": "PR Status",
-        "description": "Updates PR status reactions in engineering"
-    },
-    "features": {
-        "bot_user": {
-            "display_name": "PR Status",
-            "always_online": false
-        }
-    },
-    "oauth_config": {
-        "scopes": {
-            "bot": ["channels:history", "reactions:read", "reactions:write"]
-        }
-    },
-    "settings": {
-        "org_deploy_enabled": false,
-        "socket_mode_enabled": false,
-        "token_rotation_enabled": false
-    }
-}

.github/slack-pr-status.md

@@ -1,15 +0,0 @@
-# Slack PR status
-
-[GitbookIO/slack-pr-status](https://github.com/GitbookIO/slack-pr-status) adds review-status reactions to PR links posted in [#engineering](https://gitbook.slack.com/archives/C01NXGWJELS). It runs from `.github/workflows/slack-pr-status.yml` in `GitbookIO/gitbook`, `GitbookIO/gitbook-x` and `GitbookIO/integrations`. Emojis and statuses are configured in that workflow; see the action's README for the options.
-
-Owner: Peter White.
-
-| Configuration | Value |
-| --- | --- |
-| Slack app | **PR Status** (`A0C2AGLAD0T`), created from `.github/slack-pr-status-app-manifest.json` |
-| Bot token | Repository Actions secret `SLAPR_SLACK_BOT_TOKEN` |
-| GitHub token | The workflow's `GITHUB_TOKEN`, read-only |
-
-Posts that link PRs from more than one repository are skipped, because each workflow's token can only read its own repository. PRs from forks get no reactions, because their workflows don't receive secrets.
-
-To disable it in one repository, run `gh workflow disable slack-pr-status.yml --repo GitbookIO/<repository>`. To stop it everywhere, revoke the PR Status app's token.

.github/workflows/ci.yaml

@@ -4,17 +4,131 @@ on:
     push:
         branches:
             - main
-            - changeset-release/main
+env:
+    NPMRC_FONT_AWESOME_TOKEN: ${{ secrets.NPMRC_FONT_AWESOME_TOKEN }}
 jobs:
-    format:
+    deploy:
+        name: Deploy to Cloudflare Pages
         runs-on: ubuntu-latest
-        name: Format
-        timeout-minutes: 6
+        permissions:
+            contents: read
+            deployments: write
+        outputs:
+            deployment_url: ${{ steps.cloudflare.outputs.url }}
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Cache Next.js build
+              uses: actions/cache@v3
+              with:
+                  path: |
+                      ${{ github.workspace }}/.next/cache
+                  # Generate a new cache whenever packages or source files change.
+                  key: ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
+                  # If source files changed but packages didn't, rebuild from a prior cache.
+                  restore-keys: |
+                      ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-
+            - name: Sets env vars for production
+              run: |
+                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
+                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+              if: startsWith(github.ref, 'refs/heads/main')
+            - name: Sets env vars for preview
+              run: |
+                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
+              if: 1 && !startsWith(github.ref, 'refs/heads/main')
+            - name: Build Next.js with next-on-pages
+              run: bun run build:cloudflare
+              env:
+                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
+            - id: cloudflare
+              name: Publish to Cloudflare Pages
+              uses: cloudflare/pages-action@v1
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+                  directory: ./packages/gitbook/.vercel/output/static
+                  gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+                  workingDirectory: ./
+            - name: Outputs
+              run: |
+                  echo "ID: ${{ steps.cloudflare.outputs.id }}"
+                  echo "URL: ${{ steps.cloudflare.outputs.url }}"
+                  echo "Environment: ${{ steps.cloudflare.outputs.environment }}"
+                  echo "Alias: ${{ steps.cloudflare.outputs.alias }}"
+            - name: Archive build output
+              uses: actions/upload-artifact@v4
+              with:
+                  name: build-output
+                  path: .vercel/
+    visual-testing:
+        runs-on: ubuntu-latest
+        name: Visual Testing
+        needs: deploy
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
+            - 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.outputs.deployment_url}}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+            - uses: actions/upload-artifact@v4
+              if: ${{ !cancelled() }}
+              with:
+                  name: playwright-test-results
+                  path: packages/gitbook/test-results/
+                  retention-days: 3
+    pagespeed-testing:
+        runs-on: ubuntu-latest
+        name: PageSpeed Testing
+        needs: deploy
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run pagespeed tests
+              run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
+              env:
+                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment_url}}
+                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
+    format:
+        runs-on: ubuntu-latest
+        name: Format
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -23,54 +137,61 @@ jobs:
     lint:
         runs-on: ubuntu-latest
         name: Lint
-        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
-            - run: bun lint
+            - run: bun lint --no-cache
     test:
         runs-on: ubuntu-latest
         name: Test
-        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun unit
-    build:
+    build-oss:
+        # CI to check that the repository builds correctly on a machine without the credentials
         runs-on: ubuntu-latest
-        name: Build
-        timeout-minutes: 6
+        name: Build (Open Source)
+        env:
+            NPMRC_FONT_AWESOME_TOKEN: ''
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
-              run: bun install
+              run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun run build
     typecheck:
         runs-on: ubuntu-latest
         name: Typecheck
-        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:

.github/workflows/css-browser-compatibility.yaml

@@ -1,34 +0,0 @@
-name: CSS browser compatibility
-
-on:
-    pull_request_target:
-        types: [opened, reopened, synchronize]
-
-permissions:
-    contents: read
-    pull-requests: read
-
-concurrency:
-    group: css-browser-compatibility-${{ github.event.pull_request.number }}
-    cancel-in-progress: true
-
-jobs:
-    check:
-        name: Check newly added CSS declarations
-        runs-on: ubuntu-latest
-        timeout-minutes: 6
-        steps:
-            # pull_request_target checks out the trusted base branch by default. Never use the PR ref here.
-            - name: Checkout trusted checker
-              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: Check CSS browser compatibility
-              working-directory: packages/gitbook
-              run: bun run check:css-browser-compatibility
-              env:
-                  GITHUB_TOKEN: ${{ github.token }}

.github/workflows/deploy-preview.yaml

@@ -1,300 +0,0 @@
-name: Preview
-on:
-    pull_request_target:
-    push:
-        branches:
-            - main
-jobs:
-    approval:
-        # Ensure that external contributors' PRs are manually approved before deployment
-        name: Approve Preview Deployment
-        runs-on: ubuntu-latest
-        if: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.fork }}
-        environment:
-            name: preview-approval
-        steps:
-            - name: Approval gate
-              run: echo "Preview deployment approved."
-    deploy-v2-vercel:
-        name: Deploy v2 to Vercel (preview)
-        runs-on: ubuntu-latest
-        needs: approval
-        if: ${{ always() && (needs.approval.result == 'success' || needs.approval.result == 'skipped') }}
-        environment:
-            name: 2v-preview
-            url: ${{ steps.deploy.outputs.deployment-url }}
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Deploy to Vercel
-              id: deploy
-              uses: ./.github/composite/deploy-vercel
-              with:
-                  environment: preview
-                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
-                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
-                  opItem: op://gitbook-open/2v-preview
-                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-                  headSha: ${{ github.event.pull_request.head.sha || github.sha }}
-    deploy-v2-cloudflare:
-        name: Deploy v2 to Cloudflare Worker (preview)
-        runs-on: ubuntu-latest
-        needs: approval
-        if: ${{ always() && (needs.approval.result == 'success' || needs.approval.result == 'skipped') }}
-        environment:
-            name: 2c-preview
-            url: ${{ steps.deploy.outputs.deployment-url }}
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Deploy to Cloudflare
-              id: deploy
-              uses: ./.github/composite/deploy-cloudflare
-              with:
-                  environment: preview
-                  deploy: ${{ github.ref == 'refs/heads/main' }}
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  opItem: op://gitbook-open/2c-preview
-                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-                  commitTag: ${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
-                  commitMessage: ${{ github.sha }}
-            - name: Extract Worker ID
-              id: extract-worker-id
-              if: ${{ !steps.deploy.outputs.deployment-url }}
-              run: |
-                  if [[ "${{ steps.deploy.outputs.command-output }}" =~ Worker\ Version\ ID:\ ([0-9a-f]{8})-([0-9a-f-]+) ]]; then
-                    WORKER_ID_FIRST_PART="${BASH_REMATCH[1]}"
-                    echo "worker-url=https://${WORKER_ID_FIRST_PART}-gitbook-open-v2-preview.gitbook.workers.dev/" >> $GITHUB_OUTPUT
-                  fi
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}"
-    comment-deployments:
-        runs-on: ubuntu-latest
-        name: Comment Deployments (preview)
-        if: always() && github.event_name != 'push'
-        needs:
-            - deploy-v2-vercel
-            - deploy-v2-cloudflare
-        steps:
-            - name: Find GitHub Comment
-              uses: peter-evans/find-comment@v3
-              id: fc
-              with:
-                  issue-number: ${{ github.event.pull_request.number }}
-                  comment-author: 'github-actions[bot]'
-                  body-includes: 'Summary of the deployments'
-
-            - name: Create or update GitHub comment
-              uses: peter-evans/create-or-update-comment@v4
-              with:
-                  comment-id: ${{ steps.fc.outputs.comment-id }}
-                  issue-number: ${{ github.event.pull_request.number }}
-                  body: |
-                      Summary of the deployments:
-
-                      | Version | URL | Status |
-                      | --- | --- | --- |
-                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
-                      | Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
-
-                      ### 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) |
-                  edit-mode: replace
-    visual-testing-v2-vercel:
-        runs-on: ubuntu-latest
-        name: Visual Testing v2
-        needs: deploy-v2-vercel
-        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
-        timeout-minutes: 15
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run Playwright tests
-              run: bun e2e
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: v2-vercel
-    visual-testing-v2-cloudflare:
-        runs-on: ubuntu-latest
-        name: Visual Testing v2 (Cloudflare)
-        needs: deploy-v2-cloudflare
-        if: ${{ always() && needs.deploy-v2-cloudflare.result == 'success' }}
-        timeout-minutes: 15
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run Playwright tests
-              run: bun e2e
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: v2-cloudflare
-    visual-testing-customers-v2:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers v2
-        needs: deploy-v2-vercel
-        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
-        timeout-minutes: 30
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: customers-v2-vercel
-
-            # Style recalc depends on the client bundle, not the host, so this runs here only and
-            # not in the Cloudflare job. Kept out of `e2e-customers`, which is a visual suite.
-            - name: Run style invalidation tests
-              if: always()
-              working-directory: packages/gitbook
-              run: bun run e2e-style-perf
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-
-            # Runs on failure too: a blown style budget is exactly when the numbers are worth seeing.
-            - name: Build style invalidation report
-              if: always() && github.event_name != 'push'
-              id: style-perf
-              working-directory: packages/gitbook
-              run: |
-                  rows=$(cat test-results/style-perf.md 2>/dev/null || true)
-                  if [ -z "$rows" ]; then exit 0; fi
-                  {
-                    echo 'body<<STYLE_PERF_EOF'
-                    echo '### Style invalidation on a large API reference'
-                    echo
-                    echo 'Elements restyled by opening one popup on [the Snyk API reference](https://docs.snyk.io/snyk-api/reference/apps). A share near or above 100% means the insertion restyles the whole document.'
-                    echo
-                    echo '| interaction | restyled | page | share | budget | |'
-                    echo '| --- | ---: | ---: | ---: | ---: | :-: |'
-                    echo "$rows"
-                    echo 'STYLE_PERF_EOF'
-                  } >> "$GITHUB_OUTPUT"
-
-            - name: Find style invalidation comment
-              if: always() && github.event_name != 'push' && steps.style-perf.outputs.body != ''
-              uses: peter-evans/find-comment@v3
-              id: fc-style-perf
-              with:
-                  issue-number: ${{ github.event.pull_request.number }}
-                  comment-author: 'github-actions[bot]'
-                  body-includes: 'Style invalidation on a large API reference'
-
-            - name: Create or update style invalidation comment
-              if: always() && github.event_name != 'push' && steps.style-perf.outputs.body != ''
-              uses: peter-evans/create-or-update-comment@v4
-              with:
-                  comment-id: ${{ steps.fc-style-perf.outputs.comment-id }}
-                  issue-number: ${{ github.event.pull_request.number }}
-                  body: ${{ steps.style-perf.outputs.body }}
-                  edit-mode: replace
-    visual-testing-customers-v2-cloudflare:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers v2 (Cloudflare)
-        needs: deploy-v2-cloudflare
-        if: ${{ always() && needs.deploy-v2-cloudflare.result == 'success' }}
-        timeout-minutes: 30
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: customers-v2-cloudflare
-    browserless-testing-v2-vercel:
-        runs-on: ubuntu-latest
-        name: Browserless Testing v2 (Vercel)
-        needs: deploy-v2-vercel
-        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run tests
-              run: cd ./packages/gitbook && bun e2e-browserless
-              env:
-                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-    # browserless-testing-v2-cloudflare:
-    #     runs-on: ubuntu-latest
-    #     name: Browserless Testing v2 (Cloudflare)
-    #     needs: deploy-v2-cloudflare
-    #     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: Run tests
-    #           run: cd ./packages/gitbook && bun e2e-browserless
-    #           env:
-    #               BASE_URL: ${{needs.deploy-v2-cloudflare.outputs.deployment-url}}
-    #               SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/

.github/workflows/deploy-production.yaml

@@ -1,53 +0,0 @@
-name: Production
-on:
-    push:
-        branches:
-            - main
-jobs:
-    deploy-v2-vercel:
-        name: Deploy v2 to Vercel (production)
-        runs-on: ubuntu-latest
-        environment:
-            name: 2v-production
-            url: ${{ steps.deploy.outputs.deployment-url }}
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Deploy
-              id: deploy
-              uses: ./.github/composite/deploy-vercel
-              with:
-                  environment: production
-                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
-                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
-                  opItem: op://gitbook-open/2v-production
-                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-    deploy-v2-cloudflare:
-        name: Deploy v2 to Cloudflare Worker (production)
-        runs-on: ubuntu-latest
-        environment:
-            name: 2c-production
-            url: ${{ steps.deploy.outputs.deployment-url }}
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Deploy
-              id: deploy
-              uses: ./.github/composite/deploy-cloudflare
-              with:
-                  environment: production
-                  deploy: true
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  opItem: op://gitbook-open/2c-production
-                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-                  commitTag: main
-                  commitMessage: ${{ github.sha }}
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -1,53 +0,0 @@
-name: Staging
-on:
-    push:
-        branches:
-            - main
-jobs:
-    deploy-v2-vercel:
-        name: Deploy v2 to Vercel (staging)
-        runs-on: ubuntu-latest
-        environment:
-            name: 2v-staging
-            url: ${{ steps.deploy.outputs.deployment-url }}
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Deploy
-              id: deploy
-              uses: ./.github/composite/deploy-vercel
-              with:
-                  environment: staging
-                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
-                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
-                  opItem: op://gitbook-open/2v-staging
-                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-    deploy-v2-cloudflare:
-        name: Deploy v2 to Cloudflare Worker (staging)
-        runs-on: ubuntu-latest
-        environment:
-            name: 2c-staging
-            url: ${{ steps.deploy.outputs.deployment-url }}
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Deploy
-              id: deploy
-              uses: ./.github/composite/deploy-cloudflare
-              with:
-                  environment: staging
-                  deploy: true
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  opItem: op://gitbook-open/2c-staging
-                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-                  commitTag: main
-                  commitMessage: ${{ github.sha }}
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/publish.yaml

@@ -11,42 +11,50 @@ jobs:
     publish:
         name: Publish
         runs-on: ubuntu-latest
-        permissions:
-            id-token: write
-            pull-requests: write
-            contents: write
-        env:
-            # The repo is managed by Bun, but publishing uses npm for provenance.
-            # Keep Corepack from rejecting packageManager: bun@... when npm runs.
-            COREPACK_ENABLE_PROJECT_SPEC: 0
         steps:
             - name: Checkout Repo
               uses: actions/checkout@v3
               with:
                   # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
                   fetch-depth: 0
-            - name: Setup Node
-              uses: actions/setup-node@v4
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
               with:
-                  node-version: 22
-                  registry-url: 'https://registry.npmjs.org'
-            - name: Update npm
-              run: |
-                  corepack enable npm
-                  corepack install -g npm@latest
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Create Release Pull Request
+            - name: Create Release Pull Request or Publish to npm
               id: changesets
               uses: changesets/action@v1
               with:
-                  publish: bun run publish-all-packages
-                  version: bun run changeset-version
+                  publish: npm run release
               env:
                   # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                   # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
                   GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
+                  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: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
+            - 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 }}

.github/workflows/slack-pr-status.yml

@@ -1,33 +0,0 @@
-name: Slack PR status
-
-on:
-    pull_request_review:
-        types: [submitted, dismissed]
-    pull_request:
-        types: [closed, reopened]
-
-permissions:
-    contents: read
-    pull-requests: read
-
-jobs:
-    slack-pr-status:
-        # Secrets aren't available to workflows triggered from forks.
-        if: github.event.pull_request.head.repo.full_name == github.repository
-        runs-on: ubuntu-latest
-        steps:
-            - uses: GitbookIO/slack-pr-status@main
-              with:
-                  slack-token: ${{ secrets.SLAPR_SLACK_BOT_TOKEN }}
-                  config: |
-                      channels: [C01NXGWJELS]
-                      approvalsRequired: 1
-                      multiPr: aggregate
-                      emojis:
-                          commented: false
-                          partiallyApproved: next_track_button
-                          approved: pr-approved
-                          changesRequested: construction
-                          merged: merged
-                          closed: no_entry_sign
-                          partiallyReviewed: hourglass_flowing_sand

.gitignore

@@ -22,13 +22,3 @@ yarn-error.log*
 
 # Env files
 .env.local
-
-# TypeScript
-*.tsbuildinfo
-.npmrc
-
-# Bun pack artifacts
-packages/*/*.tgz
-
-# Playwright MCP artifacts
-.playwright-mcp/

.nvmrc

@@ -1 +1 @@
-v22.3
+v20.6

.oxfmtrc.json

@@ -1,70 +0,0 @@
-{
-    "$schema": "./node_modules/oxfmt/configuration_schema.json",
-    "printWidth": 100,
-    "tabWidth": 4,
-    "useTabs": false,
-    "semi": true,
-    "singleQuote": true,
-    "jsxSingleQuote": false,
-    "quoteProps": "as-needed",
-    "trailingComma": "es5",
-    "bracketSpacing": true,
-    "bracketSameLine": false,
-    "arrowParens": "always",
-    "endOfLine": "lf",
-    "sortImports": {
-        "customGroups": [
-            {
-                "groupName": "workspace",
-                "elementNamePattern": ["@gitbook/**"]
-            }
-        ],
-        "groups": [
-            ["value-builtin", "value-external", "type-builtin", "type-external"],
-            { "newlinesBetween": true },
-            "workspace",
-            { "newlinesBetween": true },
-            [
-                "value-internal",
-                "type-internal",
-                "value-parent",
-                "type-parent",
-                "value-sibling",
-                "type-sibling",
-                "value-index",
-                "type-index"
-            ],
-            "type-import",
-            "unknown"
-        ]
-    },
-    "sortPackageJson": false,
-    "sortTailwindcss": {
-        "config": "./packages/gitbook/tailwind.config.ts",
-        "attributes": ["class", "className", "style"],
-        "functions": ["clsx", "tw"]
-    },
-    "ignorePatterns": [
-        "**/node_modules/**",
-        "**/dist/**",
-        "**/build/**",
-        "**/public/**",
-        "**/.next/**",
-        "**/.open-next/**",
-        "**/.turbo/**",
-        "**/.vercel/**",
-        "**/.cache/**",
-        "**/.wrangler/**",
-        "**/*.log",
-        "**/*.MD",
-        "**/*.md",
-        "**/*.mdx",
-        "**/*.html",
-        "**/*.css",
-        "packages/embed/standalone/**",
-        "packages/openapi-parser/src/fixtures/**",
-        "packages/emoji-codepoints/index.ts",
-        "packages/icons/src/data/*.json",
-        "packages/gitbook/worker-configuration.d.ts"
-    ]
-}

.oxlintrc.json

@@ -1,87 +0,0 @@
-{
-    "$schema": "./node_modules/oxlint/configuration_schema.json",
-    "categories": {
-        "correctness": "warn",
-        "suspicious": "warn",
-        "perf": "warn"
-    },
-    "plugins": ["eslint", "typescript", "unicorn", "oxc", "react", "jsx-a11y", "vitest"],
-    "env": {
-        "builtin": true,
-        "browser": true,
-        "node": true,
-        "shared-node-browser": true,
-        "worker": true
-    },
-    "globals": {
-        "Bun": "readonly",
-        "GitBookIntegrationEvent": "readonly",
-        "React": "readonly"
-    },
-    "rules": {
-        "eslint/no-console": [
-            "warn",
-            {
-                "allow": ["assert", "error", "warn"]
-            }
-        ],
-        "eslint/no-control-regex": "warn",
-        "eslint/no-prototype-builtins": "warn",
-        "eslint/no-cond-assign": "warn",
-        "eslint/no-undef": "error",
-        "eslint/no-unused-vars": [
-            "error",
-            {
-                "argsIgnorePattern": "^_",
-                "caughtErrorsIgnorePattern": "^_",
-                "ignoreRestSiblings": true,
-                "varsIgnorePattern": "^_"
-            }
-        ],
-        "react/button-has-type": "warn",
-        "react/exhaustive-deps": "warn",
-        "react/jsx-key": "warn",
-        "react/jsx-no-useless-fragment": "warn",
-        "react/no-array-index-key": "warn",
-        "react/void-dom-elements-no-children": "warn",
-        "react/rules-of-hooks": "error",
-        "jsx-a11y/alt-text": "warn",
-        "jsx-a11y/anchor-is-valid": "warn",
-        "jsx-a11y/click-events-have-key-events": "warn",
-        "jsx-a11y/iframe-has-title": "warn",
-        "jsx-a11y/interactive-supports-focus": "warn",
-        "jsx-a11y/label-has-associated-control": "warn",
-        "jsx-a11y/no-noninteractive-tabindex": "warn",
-        "jsx-a11y/role-has-required-aria-props": "warn",
-        "jsx-a11y/tabindex-no-positive": "warn",
-        "typescript/array-type": "error",
-        "typescript/no-explicit-any": "warn",
-        "typescript/no-non-null-assertion": "warn",
-        "typescript/no-confusing-void-expression": "warn",
-        "typescript/only-throw-error": "error",
-        "vitest/no-focused-tests": "error",
-        "no-delete-var": "warn",
-        "no-debugger": "error",
-        "no-throw-literal": "error",
-        "use-isnan": "error",
-        "valid-typeof": "error"
-    },
-    "ignorePatterns": [
-        "**/node_modules/**",
-        "**/dist/**",
-        "**/build/**",
-        "**/public/**",
-        "**/.next/**",
-        "**/.open-next/**",
-        "**/.turbo/**",
-        "**/.vercel/**",
-        "**/.cache/**",
-        "**/.wrangler/**",
-        "packages/embed/standalone/**",
-        "packages/openapi-parser/src/fixtures/**",
-        "packages/emoji-codepoints/index.ts",
-        "packages/icons/src/data/*.json",
-        "packages/gitbook/worker-configuration.d.ts",
-        "**/*.css"
-    ]
-}