feat: docs

.github/actions/build-docs/action.yml

@@ -0,0 +1,35 @@
+name: 'Build Docs'
+description: 'Setup environment and build documentation'
+
+inputs:
+  rspress-base:
+    description: 'The value for RSPRESS_BASE environment variable'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup pnpm
+      uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
+      with:
+        version: 9.12.2
+
+    - name: Setup Node.js
+      uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
+      with:
+        node-version: 22
+        cache: 'pnpm'
+
+    - name: Install dependencies (root)
+      if: ${{ github.event.action != 'closed' }}
+      run: pnpm install --frozen-lockfile
+      shell: bash
+
+    - name: Build docs
+      if: ${{ github.event.action != 'closed' }}
+      working-directory: website
+      env:
+        NODE_ENV: production
+        RSPRESS_BASE: ${{ inputs.rspress-base }}
+      run: pnpm run build
+      shell: bash

.github/workflows/deploy.yml

@@ -0,0 +1,31 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: true
+
+      - name: Build docs
+        uses: ./.github/actions/build-docs
+        with:
+          rspress-base: /${{ github.event.repository.name }}/
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
+        with:
+          folder: website/doc_build
+          branch: gh-pages
+          clean-exclude: pr-preview
+          force: false

.github/workflows/pr-preview.yml

@@ -0,0 +1,37 @@
+name: Deploy PR previews
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      pages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: true
+
+      - name: Build docs
+        uses: ./.github/actions/build-docs
+        with:
+          rspress-base: /${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.number }}/
+
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1.8.1
+        with:
+          source-dir: website/doc_build
+          preview-branch: gh-pages
+          qr-code: true
+          wait-for-pages-deployment: true

CONTRIBUTING.md

@@ -5,6 +5,7 @@ Thanks for your interest in contributing to agent-device.
 ## Development
 
 Requirements:
+
 - Node.js 22+
 - pnpm
 - Android SDK tools (`adb`) for Android support
@@ -16,25 +17,35 @@ Setup:
 pnpm install
 ```
 
+Build all CLIs and Xcode projects:
+
+```bash
+pnpm build:all
+```
+
 Run tests:
 
 ```bash
 pnpm test
 ```
 
 Optional device selectors for tests:
+
 - `ANDROID_DEVICE=Pixel_9_Pro_XL` or `ANDROID_SERIAL=emulator-5554`
 - `IOS_DEVICE="iPhone 17 Pro"` or `IOS_UDID=<udid>`
 
 ## Guidelines
+
 - Keep dependencies minimal.
 - Preserve the CLI’s agent-friendly JSON output.
 - Ensure tests open and close sessions explicitly.
 - Add/adjust integration tests when introducing new commands.
 - Prefer built-in Node APIs over new packages.
 
 ## Reporting issues
+
 Please include:
+
 - OS and Node version
 - Xcode/Android SDK versions (if relevant)
 - Exact command and output

README.md

@@ -1,3 +1,11 @@
+<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=agent-device" align="center">
+  <picture>
+    <img alt="agent-device" src="website/docs/public/agent-device-banner.jpg">
+  </picture>
+</a>
+
+---
+
 # agent-device
 
 CLI to control iOS and Android devices for AI agents influenced by Vercel’s [agent-browser](https://github.com/vercel/agent-browser).