Clean up

.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.

.bun-version

@@ -0,0 +1 @@
+1.1.40

.changeset/angry-lemons-greet.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix UI search without ask AI enabled and fix error with questions not returned from API

.changeset/angry-spies-appear.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix empty sitemap

.changeset/blue-baboons-exercise.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Adapt code to pull token from customer backend generated custom cookies

.changeset/brave-glasses-do.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Add support for keyboard marks

.changeset/breezy-days-pull.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix search no results error showing while there are results

.changeset/chilled-coats-punch.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Log component stack in Sentry

.changeset/chilled-kids-draw.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Reintroduce a safety check around search whilst we continue investigating caching.

.changeset/clever-mangos-explode.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues

.changeset/clever-pumas-pump.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Handle security issue with cookies on Safari

.changeset/cold-wombats-chew.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add in HTTP example code blocks

.changeset/curly-apricots-happen.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Investigate an issue causing caches to return empty objects instead of null/undefined.

.changeset/curly-news-do.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add an optional client context to get a callback called when the Scalar client is opened for a block.

.changeset/dirty-ties-brush.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix vertical section overflow color

.changeset/dull-chefs-talk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Reduce gap between subsequent header buttons

.changeset/dull-goats-jam.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix pass Sentry release properly

.changeset/dull-melons-beam.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix shrinking page icons

.changeset/dull-parents-breathe.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for sidebar background styles

.changeset/early-spiders-guess.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Start using tint in more places, TOC and PageAside

.changeset/eight-hounds-fry.md

@@ -0,0 +1,7 @@
+---
+'gitbook': patch
+---
+
+Ignore invalid API calls to `getSiteRedirectFromSource` API
+
+To reduce the load on the API and also avoid errors.

.changeset/eighty-poems-reflect.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Remove KV cache backend and only rely on DO as an external cache backend

.changeset/fair-frogs-fetch.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Ignore errors from event flushing

.changeset/few-rocks-film.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Simplify search results logic to investigate a bug

.changeset/fluffy-panthers-unite.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Try to fix error on og image generation

.changeset/forty-jars-fly.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve emoji setup, align with GitBook app

.changeset/fresh-lemons-pull.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.

.changeset/fuzzy-crabs-argue.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix an issue where the redirects of potentially malicious images were not going through.

.changeset/giant-wolves-study.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix zoom image view transition on Safari

.changeset/gorgeous-horses-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Position the variant picker in the ToC

.changeset/gorgeous-kids-dream.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update footer styling and allow for more than 4 footer groups

.changeset/gorgeous-kiwis-check.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Make cookies access safer

.changeset/grumpy-zoos-rush.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix Image blocks zoomable behaviour

.changeset/happy-emus-invite.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Handle Firefox security error on localStorage

.changeset/hip-comics-cross.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix errors from customization not found

.changeset/honest-teachers-enjoy.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve contrast of search box placeholder

.changeset/large-ligers-nail.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix regression issue with page icons for multi-line titles

.changeset/late-pots-remain.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix OG image generation for non-latin characters

.changeset/late-scissors-destroy.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Simplify the `useHash` algo used.

.changeset/lazy-beans-call.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Ignore cache invalidation error from local backend

.changeset/long-pumpkins-roll.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Track events for site insights using the new dedicated API.

.changeset/loud-files-tap.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.

.changeset/mean-pears-live.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve colour contrast of list item decoration

.changeset/modern-walls-argue.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Set Sentry release

.changeset/moody-hairs-call.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': minor
+'gitbook': minor
+---
+
+Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider

.changeset/nasty-apricots-wash.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-contentkit': minor
+'gitbook': minor
+---
+
+Send redirectOnError param to getPublishedContent when token is pulled from cookie

.changeset/nasty-parents-sell.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Restyle PageAside to use sidebar list styles

.changeset/neat-donuts-teach.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-contentkit': patch
+---
+
+Fix potential invalid URL error in react-contentkit

.changeset/neat-pants-impress.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Avoid error on fetch by passing a string URL

.changeset/nervous-flowers-happen.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Generate sitemap for all sections and spaces

.changeset/nice-spoons-double.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.

.changeset/nine-gorillas-turn.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Track clicks on links (header, footer, content) for site insights.

.changeset/olive-pillows-kick.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update the routes for changes/revisions in multi-id mode to match the normal mode

.changeset/orange-chicken-develop.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix code format overriding inline link styles

.changeset/perfect-boxes-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix emojis display

.changeset/perfect-laws-pay.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix server actions stability leading to no results found sometimes on search

.changeset/polite-spies-beg.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Lazy load iframely script to make page more responsive

.changeset/poor-carrots-taste.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them

.changeset/popular-feet-bake.md

@@ -0,0 +1,7 @@
+---
+'gitbook': patch
+---
+
+Implement a safer way to interact with localStorage.
+
+If it's disabled on the browser it should not throw error.

.changeset/pretty-elephants-glow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix search UI behaviour

.changeset/pretty-penguins-carry.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix two issues where pages would crash due Recoil not behaving correctly in RSC.

.changeset/quiet-oranges-provide.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix dynamic tabs infinite loop

.changeset/quiet-zoos-applaud.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Prevent codemirror from loading multiple versions in scalar

.changeset/remove-chatgpt-markdown.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Remove the ChatGPT-specific plain text response for Markdown and llms.txt routes; these now always serve `text/markdown`.

.changeset/rich-impalas-applaud.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix error when accessing a change request not found

.changeset/selfish-rivers-approve.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Grow search bar conditionally if <5 header links are present

.changeset/serious-dancers-clean.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix variant selector contrast for non-default themes

.changeset/seven-hounds-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix issue leading to increase the storage write and the stability of the platform

.changeset/shiny-cheetahs-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Force route handler to be dynamic to avoid errors

.changeset/shiny-seahorses-explode.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Updated scalar depdenency

.changeset/silly-books-enjoy.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix search loading state

.changeset/silver-dancers-heal.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Disable C/C++ highlight temporarily

.changeset/spicy-mugs-eat.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix Sentry instrumentation

.changeset/strange-hornets-trade.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Even safer localStorage

.changeset/stupid-beans-travel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Avoid errors on legacy browsers

.changeset/sweet-tools-fly.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add antialiasing for text rendering

.changeset/tame-worms-march.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Improve readability of tables with hover style and vertical dividers

.changeset/tasty-cooks-kneel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve styling of header buttons with shadows and high-contrast styles

.changeset/tasty-rocks-matter.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix viewing PDF from space

.changeset/tender-bags-guess.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Image optimization endpoint redirects to underlying image URL if the signature is not the latest.

.changeset/thick-ears-reply.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix bullet list display on full size blocks

.changeset/thick-items-sneeze.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Vertical orientation for sections list on sites without header

.changeset/thirty-berries-bow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix error when accessing some not found pages.

.changeset/three-sloths-taste.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix "Parser" language syntax highlighting

.changeset/twelve-books-dream.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix a vulnerability issue for images using an older version of the image signing parameter.

.changeset/twelve-doors-film.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Track an event into site insights when visitor is opening the Scalar API client.

.changeset/twenty-rocks-tickle.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine

.changeset/two-beans-smell.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix breadcrumbs emoji display + add contrast styles

.changeset/two-mirrors-move.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix server actions cache compromised. Leading to some bugs on frontend.

.changeset/violet-parents-marry.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve smoothness of scroll listener

.changeset/wicked-apricots-drop.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix variant dropdown styling in header

.changeset/wild-chicken-matter.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix view transition error on Safari

.changeset/wild-lemons-camp.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Bump `heading-3` font size to offset it from paragraphs

.changeset/wise-otters-hear.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix Sentry instrumentation server-side

.changeset/yellow-singers-walk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.

.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,91 +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.
 
-The [`@gitbook/embed`](https://github.com/GitbookIO/gitbook/blob/main/packages/embed) package is distributed under the [Apache License 2.0](https://github.com/GitbookIO/gitbook/blob/main/packages/embed/LICENSE). Contributions to it are made under the same license.
+### 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.