Enhance deployment script and documentation for GitHub Pages

- Updated deploy.sh to include error handling and SSH support for GitHub repository URLs.
- Modified package.json to streamline the deploy command.
- Improved README.md with clearer deployment instructions and emphasized the use of the main branch for GitHub Pages.

Author: Freddy03h

.github/workflows/build.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [src]
+  pull_request:
+    branches: [src]
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+      - name: Install
+        run: npm ci
+      - name: Build
+        run: npm run build
+
+  deploy:
+    needs: build
+    if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Deploy to GitHub Pages (main)
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build
+          publish_branch: main
+          force_orphan: true
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/ci.yml

@@ -6,6 +6,9 @@ This website is built using [Docusaurus 3](https://docusaurus.io/), a modern sta
 
 Requires **Node.js 18+** (see `.node-version`).
 
+Source lives on the **`src`** branch. GitHub Pages serves the built site from
+**`main`**.
+
 ## Installation
 
 ```console
@@ -18,23 +21,42 @@ npm install
 npm start
 ```
 
-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
 
 ## Build
 
 ```console
 npm run build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the `build` directory.
 
 ## Deployment
 
+### Automatic (recommended)
+
+Push to the **`src`** branch (or run the workflow manually). GitHub Actions
+builds the site and publishes `build/` to **`main`** (GitHub Pages).
+
+Workflow: [`.github/workflows/ci.yml`](.github/workflows/ci.yml)
+
+### Manual
+
+```console
+npm run deploy
+```
+
+Requires push access to the repo (SSH recommended). Optional overrides:
+
 ```console
-GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy
+GIT_DEPLOY_REPO=git@github.com:rescript-react-native/rescript-react-native.github.io.git \
+GIT_USER_NAME="Your Name" \
+GIT_USER_EMAIL="you@example.com" \
+npm run deploy
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+> Do not use `docusaurus deploy` / a `gh-pages` branch for this repo — Pages is
+> configured on `main`.
 
 ---
 

README.md

@@ -1,10 +1,33 @@
 #!/usr/bin/env bash
+set -euo pipefail
+
+# Publish the static site from ./build to the GitHub Pages branch (main).
+# Source lives on the `src` branch; GitHub Pages serves `main`.
+
+ROOT="$(cd "$(dirname "$0")" && pwd)"
+cd "$ROOT"
+
+if [[ ! -d build ]]; then
+  echo "Missing ./build — run \`npm run build\` first (or \`npm run deploy\`)." >&2
+  exit 1
+fi
+
 GIT_DEPLOY_REPO=${GIT_DEPLOY_REPO:-$(node -e 'process.stdout.write(require("./package.json").repository)')}
 
-cd build && \
-rm -rf .git && \
-git init && \
-git checkout -b main && \
-git add . -A && \
-git commit -m "Deploy to GitHub Pages" && \
+# Prefer SSH when the default HTTPS URL is used (typical for local deploys).
+if [[ "${GIT_DEPLOY_REPO}" == https://github.com/* ]]; then
+  GIT_DEPLOY_REPO="git@github.com:${GIT_DEPLOY_REPO#https://github.com/}"
+  GIT_DEPLOY_REPO="${GIT_DEPLOY_REPO%.git}.git"
+fi
+
+cd build
+rm -rf .git
+git init
+git checkout -b main
+git add -A
+git -c user.name="${GIT_USER_NAME:-github-pages}" \
+    -c user.email="${GIT_USER_EMAIL:-github-pages@users.noreply.github.com}" \
+    commit -m "Deploy to GitHub Pages"
 git push --force "${GIT_DEPLOY_REPO}" main:main
+
+echo "Deployed to ${GIT_DEPLOY_REPO} (main)"

deploy.sh

@@ -8,12 +8,11 @@
     "start": "docusaurus start",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
-    "deploy": "docusaurus deploy",
+    "deploy": "npm run build && ./deploy.sh",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids",
-    "publish": "npm run build && ./deploy.sh"
+    "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
     "@docusaurus/core": "^3.10.2",