From eefef7d57331ba26f804c89a05cac0cb862ff134 Mon Sep 17 00:00:00 2001
From: Devin <devin@a2-ai.com>
Date: Fri, 1 Nov 2024 13:22:16 +0000
Subject: [PATCH] docs: setup github pages

---
 .Rbuildignore                  |  4 +++
 .github/.gitignore             |  1 +
 .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++++++++++++++
 .gitignore                     |  1 +
 DESCRIPTION                    |  1 +
 _pkgdown.yml                   |  4 +++
 6 files changed, 61 insertions(+)
 create mode 100644 .github/.gitignore
 create mode 100644 .github/workflows/pkgdown.yaml
 create mode 100644 _pkgdown.yml

diff --git a/.Rbuildignore b/.Rbuildignore
index ae8d3b7..987ab3b 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -5,3 +5,7 @@
 ^LICENSE\.md$
 ^README\.Rmd$
 ^.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$
diff --git a/.github/.gitignore b/.github/.gitignore
new file mode 100644
index 0000000..2d19fc7
--- /dev/null
+++ b/.github/.gitignore
@@ -0,0 +1 @@
+*.html
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..4bbce75
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,50 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
index aa6021e..c0ef0af 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,4 @@
 .quarto
 r_lib/
 inst/header.tex
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
index 7a565a0..3b492fa 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -47,3 +47,4 @@ Suggests:
     knitr,
     shinytest2
 Config/testthat/edition: 3
+URL: https://a2-ai.github.io/ghqc.app/
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..0aa65b4
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,4 @@
+url: https://a2-ai.github.io/ghqc.app/
+template:
+  bootstrap: 5
+