From be3f2a5c3c17cc5170232cc8aeb05721e5818e00 Mon Sep 17 00:00:00 2001
From: Qile0317 <qile0317@gmail.com>
Date: Tue, 28 May 2024 12:38:41 -0700
Subject: [PATCH] init pkgdown job

---
 .github/workflows/pkgdown.yaml | 46 ++++++++++++++++++++++++++++++++++
 DESCRIPTION                    |  1 +
 man/FastUtils-package.Rd       |  5 ++--
 3 files changed, 50 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/pkgdown.yaml

diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..37b2918
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,46 @@
+# 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, dev, unstable]
+    pull_request:
+      branches: [main, dev, unstable]
+    release:
+      types: [published]
+    workflow_dispatch:
+  
+  name: pkgdown
+  
+  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 }}
+      steps:
+        - uses: actions/checkout@v3
+  
+        - 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.4.1
+          with:
+            clean: false
+            branch: gh-pages
+            folder: docs
\ No newline at end of file
diff --git a/DESCRIPTION b/DESCRIPTION
index ad9d969..3152a5d 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -31,3 +31,4 @@ Config/testthat/edition: 3
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
 VignetteBuilder: knitr
+URL: https://github.com/Qile0317/FastUtils
diff --git a/man/FastUtils-package.Rd b/man/FastUtils-package.Rd
index 682f44d..cb6cbea 100644
--- a/man/FastUtils-package.Rd
+++ b/man/FastUtils-package.Rd
@@ -4,13 +4,14 @@
 \name{FastUtils-package}
 \alias{FastUtils}
 \alias{FastUtils-package}
-\title{FastUtils: Fast, readable utility functions}
+\title{FastUtils: Fast, Readable Uutility Functions}
 \description{
-for general use. All functions have vectorized implementations whenever possible.
+A wide variety of tools for general data analysis, wrangling, package development. All functions have vectorized implementations whenever possible.
 }
 \seealso{
 Useful links:
 \itemize{
+  \item \url{https://github.com/Qile0317/FastUtils}
   \item Report bugs at \url{https://github.com/Qile0317/FastUtils/issues/}
 }