Merge pull request #3 from PumasAI/mh/docscleanup

Add docs cleanup workflow, expand README

.github/workflows/DocPreviewCleanup.yml

@@ -0,0 +1,28 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+          if [ -d "previews/PR$PRNUM" ]; then
+            git config user.name "Documenter.jl"
+            git config user.email "[email protected]"
+            git rm -rf "previews/PR$PRNUM"
+            git commit -m "delete preview"
+            git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+            git push --force origin gh-pages-new:gh-pages
+          fi
+        env:
+          PRNUM: ${{ github.event.number }}

README.md

@@ -2,6 +2,12 @@
 
 Helper functions and other utilities for use in `.qmd` notebooks.
 
+This package should be used in conjuction with Quarto notebooks that are run using
+[`QuartoNotebookRunner.jl`](https://github.com/PumasAI/QuartoNotebookRunner.jl).
+
+Add `QuartoTools` to your notebook's `Project.toml` as a dependency and then
+import it into your notebook with `using QuartoTools`. See the documentation
+for further details.
+
 [![](https://img.shields.io/badge/Docs-Stable-lightgrey.svg)](https://pumasai.github.io/QuartoTools.jl/stable/)
 [![](https://img.shields.io/badge/Docs-Dev-blue.svg)](https://pumasai.github.io/QuartoTools.jl/dev/)
-