Suggestions

.github/workflows/deploy-website.yaml

@@ -1,4 +1,4 @@
-name: Update `error-prone.picnic.tech` website contents
+name: Update `error-prone.picnic.tech` website content
 on:
   push:
     branches: [$default-branch]
@@ -17,16 +17,17 @@ jobs:
       - name: Check out code
         uses: actions/[email protected]
       - name: Configure Github Pages
-        uses: actions/configure-pages@v2.0.0
+        uses: actions/configure-pages@v2.1.1
       - name: Generate documentation
         run:  bash ./generate-docs.sh
       - name: Build website with Jekyll
         uses: actions/[email protected]
         with:
           source: website/
           destination: ./_site
-      - name: Upload website artifact
-        uses: actions/[email protected]
+      - name: Upload website as artifact
+        uses: actions/[email protected]
+
   deploy:
     environment:
       name: github-pages
@@ -36,4 +37,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1.0.9
+        uses: actions/deploy-pages@v1.2.1

generate-docs.sh

@@ -4,7 +4,7 @@ WEBSITE_FOLDER="website"
 HOMEPAGE="${WEBSITE_FOLDER}/index.md"
 
 configure() {
-    cd "$(git rev-parse --show-toplevel || echo .)"
+    cd "$(git rev-parse --show-toplevel || echo .)" || exit
     mkdir "${BUGPATTERN_FOLDER}" 2>/dev/null
     mkdir "${REFASTER_FOLDER}" 2>/dev/null
 }
@@ -29,6 +29,5 @@ EOF
     sed $SEDOPTION 's/srcset="website\//srcset="/g' ${HOMEPAGE}
 }
 
-# Do it
 configure
 generate_homepage

website/Gemfile

@@ -1,3 +1,3 @@
 source "https://rubygems.org"
 gem "github-pages", "~> 227"
-gem "rake", "~> 13.0" # Required for "just-the-docs" theme
+gem "rake", "~> 13.0" # Required for "just-the-docs" theme.

website/_config.yml

@@ -9,7 +9,7 @@ remote_theme: just-the-docs/just-the-docs
 plugins:
 - jekyll-remote-theme
 
-# Do not deploy through GitHub pages.
+# Do not deploy these files through GitHub pages.
 exclude:
   - Gemfile
   - Gemfile.lock

website/_includes/head_custom.html

@@ -10,7 +10,7 @@
 <meta name="theme-color" content="#ffffff">
 
 <!-- Support light and dark mode, as it's not natively supported.
-    See: https://github.com/just-the-docs/just-the-docs/issues/234 -->
+    See https://github.com/just-the-docs/just-the-docs/issues/234. -->
 <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-light.css' | relative_url }}"
     media="(prefers-color-scheme: light)">
 <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-dark.css' | relative_url }}"

website/_sass/custom/custom.scss

@@ -1,6 +1,6 @@
 // We should override $nav-width(-md), however this breaks code highlighting and other styles.
-// This appears an issue wrt the recommended way.
-// See: https://github.com/just-the-docs/just-the-docs/issues/982
+// This seems to be an issue for following the recommended approach.
+// See https://github.com/just-the-docs/just-the-docs/issues/982.
 @include mq(lg) {
     .side-bar {
         min-width: 400px;