Docs: adds Docusaurus site

.github/maintainers_guide.md

@@ -111,7 +111,7 @@ If you want to test the package locally you can.
 
 ### Releasing
 
-#### Generate API documents
+#### Generate API reference documents
 
 ```bash
 ./scripts/generate_api_docs.sh
@@ -230,6 +230,10 @@ with labels. An issue should have **one** of the following labels applied: `bug`
 Issues are closed when a resolution has been reached. If for any reason a closed issue seems relevant once again,
 reopening is great and better than creating a duplicate issue.
 
+## Managing Documentation
+
+See the [`/docs/README.md`](./docs/README.md) file for documentation instructions. 
+
 ## Everything else
 
 When in doubt, find the other maintainers and ask.

.github/workflows/docs-deploy.yml

@@ -0,0 +1,62 @@
+name: Deploy to GitHub Pages
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: ./docs
+
+      - name: Build website
+        run: npm run build
+        working-directory: ./docs
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    if: github.event_name != 'pull_request'
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # verifies deployment is from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -1,8 +1,3 @@
-_site
-Gemfile.lock
-.env
-.jekyll-metadata
-.vscode/
-.bundle/
-vendor/
-.ruby-version
+node_modules/
+.docusaurus
+build