Merge pull request #6 from CSOgroup/dev

Dev

Author: Arvindiyer

.github/workflows/R-CMD-check.yaml

@@ -26,7 +26,7 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - uses: r-lib/actions/setup-pandoc@v2
 

.github/workflows/pkgdown.yaml

@@ -0,0 +1,47 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+on:
+  push:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+
+      - 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
+        id: deployment
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs
+          clean: false

.gitignore

@@ -6,6 +6,7 @@
 .quarto
 .ipynb_checkpoints
 inst/doc
+docs/
 .*
 !/.gitignore
 !/.github

README.Rmd

@@ -13,9 +13,10 @@ knitr::opts_chunk$set(
 )
 ```
 
-# SelectSim <img src="man/figures/logo.png" align="right" height="138" alt="" />
+# SelectSim <a href="https://csogroup.github.io/SelectSim/"><img src="man/figures/logo.png" align="right" height="138" alt="SelectSim website" /></a>
 
 <!-- badges: start -->
+[![R-CMD-check](https://github.com/CSOgroup/SelectSim/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CSOgroup/SelectSim/actions/workflows/R-CMD-check.yaml)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19680236.svg)](https://doi.org/10.5281/zenodo.19680236)
 <!-- badges: end -->
 

README.md

@@ -1,10 +1,11 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# SelectSim <img src="man/figures/logo.png" align="right" height="138" alt="" />
+# SelectSim <a href="https://csogroup.github.io/SelectSim/"><img src="man/figures/logo.png" align="right" height="138" alt="SelectSim website" /></a>
 
 <!-- badges: start -->
 
+[![R-CMD-check](https://github.com/CSOgroup/SelectSim/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CSOgroup/SelectSim/actions/workflows/R-CMD-check.yaml)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19680236.svg)](https://doi.org/10.5281/zenodo.19680236)
 <!-- badges: end -->
 

_pkgdown.yml

@@ -10,6 +10,11 @@ home:
     structure: [links, license, citation, authors, dev]
 
 navbar:
+  logo:
+    src: logo.svg
+    alt: SelectSim
+    width: 30
+    href: https://csogroup.github.io/SelectSim/
   structure:
     left:  [intro, reference, articles, news]
     right: [github]