Skip to content

Commit 4195995

Browse files
committed
feat: docs v1
1 parent a478173 commit 4195995

26 files changed

Lines changed: 2886 additions & 277 deletions
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: 'Build Docs'
2+
description: 'Setup environment and build documentation'
3+
4+
inputs:
5+
rspress-base:
6+
description: 'The value for RSPRESS_BASE environment variable'
7+
required: true
8+
9+
runs:
10+
using: 'composite'
11+
steps:
12+
- name: Setup pnpm
13+
uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
14+
with:
15+
version: 9.12.2
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
19+
with:
20+
node-version: 22
21+
cache: 'pnpm'
22+
23+
- name: Install dependencies (root)
24+
if: ${{ github.event.action != 'closed' }}
25+
run: pnpm install --frozen-lockfile
26+
shell: bash
27+
28+
- name: Install dependencies (docs)
29+
if: ${{ github.event.action != 'closed' }}
30+
working-directory: website
31+
run: pnpm install --frozen-lockfile
32+
shell: bash
33+
34+
- name: Build docs
35+
if: ${{ github.event.action != 'closed' }}
36+
working-directory: website
37+
env:
38+
NODE_ENV: production
39+
RSPRESS_BASE: ${{ inputs.rspress-base }}
40+
run: pnpm run build
41+
shell: bash

.github/workflows/deploy.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
pages: write
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
17+
with:
18+
persist-credentials: true
19+
20+
- name: Build docs
21+
uses: ./.github/actions/build-docs
22+
with:
23+
rspress-base: /${{ github.event.repository.name }}/
24+
25+
- name: Deploy
26+
uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
27+
with:
28+
folder: website/doc_build
29+
branch: gh-pages
30+
clean-exclude: pr-preview
31+
force: false

.github/workflows/pr-preview.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy PR previews
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- reopened
8+
- synchronize
9+
- closed
10+
11+
concurrency: preview-${{ github.ref }}
12+
13+
jobs:
14+
deploy-preview:
15+
runs-on: ubuntu-latest
16+
permissions:
17+
contents: write
18+
pull-requests: write
19+
pages: write
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
23+
with:
24+
persist-credentials: true
25+
26+
- name: Build docs
27+
uses: ./.github/actions/build-docs
28+
with:
29+
rspress-base: /${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.number }}/
30+
31+
- name: Deploy preview
32+
uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1.8.1
33+
with:
34+
source-dir: website/doc_build
35+
preview-branch: gh-pages
36+
qr-code: true
37+
wait-for-pages-deployment: true

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=agent-device" align="center">
2+
<picture>
3+
<img alt="agent-device" src="website/docs/public/agent-device-banner.jpg">
4+
</picture>
5+
</a>
6+
7+
---
8+
19
# agent-device
210

311
CLI to control iOS and Android devices for AI agents influenced by Vercel’s [agent-browser](https://github.com/vercel/agent-browser).

docs/ios-automation.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/ios-runner-protocol.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

0 commit comments

Comments
 (0)