hcilab · mvanderkamp · Jun 19, 2023 · Jun 19, 2023 · Jun 19, 2023 · Jun 19, 2023
diff --git a/.github/workflows/deploy-documentation.yaml b/.github/workflows/deploy-documentation.yaml
@@ -0,0 +1,38 @@
+---
+name: Build and Deploy
+
+on:
+  push:
+    branches:
+      - deploy-docs
+
+  # This allows manual triggers. Select the branch you want to deploy as the
+  # branch to run the workflow from.
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    # Recommended if you intend to make multiple deployments in quick
+    # succession.
+    concurrency: ci-${{ github.ref }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛎️ Checkout
+        uses: actions/checkout@v3
+
+      # This example project is built using npm and outputs the result to the
+      # 'docs' folder.
+      - name: 🔧 Install and Build
+        run: |
+          npm ci
+          npm run docs
+
+      - name: 🚀 Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # The folder the action should deploy.
+          folder: docs
diff --git a/README.md b/README.md
@@ -33,6 +33,11 @@ We use browser windows to represent screens because browsers are extremely flexi
     - [Custom events](#custom-events)
     - [Interaction rights](#interaction-rights)
     - [Grouped items](#grouped-items)
+- [Contributing](#contributing)
+    - [Setup](#setup)
+    - [Workflow](#workflow)
+        - [Linting](#linting)
+    - [Deploying Documentation](#deploying-documentation)
 
 ## Installation
 
@@ -644,11 +649,11 @@ Groups can only be moved together- rotation and scaling are not supported.
 
 ---
 
-# Contribution
+## Contributing
 
 We welcome contribution to WAMS, please find details on how to setup your local development environment.
 
-## Setup
+### Setup
 
 WAMS is a Node.js projects, and with that requires that you have Node installed. We recommend using [ASDF](https://asdf-vm.com/) or [NVM](https://github.com/nvm-sh/nvm) as your Node Version Manager to install the correct version of Node.
 
@@ -672,9 +677,9 @@ npm install
 <!-- **Step #3:** Build the project -->
 <!-- TODO: Figure out how to build or test the project -->
 
-## Workflow
+### Workflow
 
-### Linting
+#### Linting
 
 The package.json file include a `lint` script that will run the linter via the CLI via
 
@@ -688,6 +693,15 @@ To fix linting errors, run
 npm run lint:fix
 ```
 
-#### Automatic Linting/Format On Save
+##### Automatic Linting/Format On Save
 
 To enable automatic linting and saving on save, you can download the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) VS Code extension. All other required settings are included in the `.vscode/settings.json` file.
+
+### Deploying Documentation
+
+The documentation is served from the branch `gh-pages`. This branch is built using a github action, which is triggered by pushes to the `deploy-docs` branch.
+
+When you want to have changes in the code reflected in the documentation:
+1. Test the documentation changes locally using `npm run build` then opening `docs/index.html` and browsing. There is no need to commit the docs folder.
+2. Open a PR and merge your changes into main.
+3. Merge main into `deploy-docs` and push the changes to github.
diff --git a/docs/client.js.html b/docs/client.js.html
diff --git a/docs/client_ClientController.js.html b/docs/client_ClientController.js.html
diff --git a/docs/client_ClientElement.js.html b/docs/client_ClientElement.js.html
diff --git a/docs/client_ClientImage.js.html b/docs/client_ClientImage.js.html
diff --git a/docs/client_ClientItem.js.html b/docs/client_ClientItem.js.html
diff --git a/docs/client_ClientModel.js.html b/docs/client_ClientModel.js.html
diff --git a/docs/client_ClientView.js.html b/docs/client_ClientView.js.html
diff --git a/docs/client_Interactor.js.html b/docs/client_Interactor.js.html
diff --git a/docs/client_ShadowView.js.html b/docs/client_ShadowView.js.html
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.eot b/docs/fonts/Montserrat/Montserrat-Bold.eot
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.ttf b/docs/fonts/Montserrat/Montserrat-Bold.ttf
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.woff b/docs/fonts/Montserrat/Montserrat-Bold.woff
diff --git a/docs/fonts/Montserrat/Montserrat-Bold.woff2 b/docs/fonts/Montserrat/Montserrat-Bold.woff2
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.eot b/docs/fonts/Montserrat/Montserrat-Regular.eot
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.ttf b/docs/fonts/Montserrat/Montserrat-Regular.ttf
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.woff b/docs/fonts/Montserrat/Montserrat-Regular.woff
diff --git a/docs/fonts/Montserrat/Montserrat-Regular.woff2 b/docs/fonts/Montserrat/Montserrat-Regular.woff2
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 b/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff
diff --git a/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 b/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/mixins.js.html b/docs/mixins.js.html
diff --git a/docs/mixins_Hittable.js.html b/docs/mixins_Hittable.js.html
diff --git a/docs/mixins_Identifiable.js.html b/docs/mixins_Identifiable.js.html
diff --git a/docs/mixins_Interactable.js.html b/docs/mixins_Interactable.js.html
diff --git a/docs/mixins_Lockable.js.html b/docs/mixins_Lockable.js.html
diff --git a/docs/mixins_Locker.js.html b/docs/mixins_Locker.js.html
diff --git a/docs/mixins_Publishable.js.html b/docs/mixins_Publishable.js.html
diff --git a/docs/mixins_Transformable2D.js.html b/docs/mixins_Transformable2D.js.html
diff --git a/docs/module-client.ClientController.html b/docs/module-client.ClientController.html
diff --git a/docs/module-client.ClientElement.html b/docs/module-client.ClientElement.html
diff --git a/docs/module-client.ClientImage.html b/docs/module-client.ClientImage.html
diff --git a/docs/module-client.ClientItem.html b/docs/module-client.ClientItem.html
diff --git a/docs/module-client.ClientModel.html b/docs/module-client.ClientModel.html
diff --git a/docs/module-client.ClientView.html b/docs/module-client.ClientView.html
diff --git a/docs/module-client.Interactor.html b/docs/module-client.Interactor.html
diff --git a/docs/module-client.ShadowView.html b/docs/module-client.ShadowView.html
diff --git a/docs/module-client.html b/docs/module-client.html
diff --git a/docs/module-mixins.Hittable.html b/docs/module-mixins.Hittable.html
diff --git a/docs/module-mixins.Identifiable.html b/docs/module-mixins.Identifiable.html
diff --git a/docs/module-mixins.Interactable.html b/docs/module-mixins.Interactable.html
diff --git a/docs/module-mixins.Lockable.html b/docs/module-mixins.Lockable.html
diff --git a/docs/module-mixins.Locker.html b/docs/module-mixins.Locker.html
diff --git a/docs/module-mixins.Publishable.html b/docs/module-mixins.Publishable.html
diff --git a/docs/module-mixins.Transformable2D.html b/docs/module-mixins.Transformable2D.html
diff --git a/docs/module-mixins.html b/docs/module-mixins.html
diff --git a/docs/module-predefined.actions.html b/docs/module-predefined.actions.html
diff --git a/docs/module-predefined.html b/docs/module-predefined.html
diff --git a/docs/module-predefined.items.html b/docs/module-predefined.items.html
diff --git a/docs/module-predefined.layouts.Line.html b/docs/module-predefined.layouts.Line.html
diff --git a/docs/module-predefined.layouts.Table.html b/docs/module-predefined.layouts.Table.html
diff --git a/docs/module-predefined.layouts.html b/docs/module-predefined.layouts.html
diff --git a/docs/module-predefined.routing.html b/docs/module-predefined.routing.html
diff --git a/docs/module-predefined.utilities.html b/docs/module-predefined.utilities.html
diff --git a/docs/module-server.Application.html b/docs/module-server.Application.html
diff --git a/docs/module-server.Device.html b/docs/module-server.Device.html
diff --git a/docs/module-server.GestureController.html b/docs/module-server.GestureController.html
diff --git a/docs/module-server.MessageHandler.html b/docs/module-server.MessageHandler.html
diff --git a/docs/module-server.ServerController.html b/docs/module-server.ServerController.html
diff --git a/docs/module-server.ServerElement.html b/docs/module-server.ServerElement.html
diff --git a/docs/module-server.ServerGroup.html b/docs/module-server.ServerGroup.html
diff --git a/docs/module-server.ServerImage.html b/docs/module-server.ServerImage.html
diff --git a/docs/module-server.ServerItem.html b/docs/module-server.ServerItem.html
diff --git a/docs/module-server.ServerView.html b/docs/module-server.ServerView.html
diff --git a/docs/module-server.ServerViewGroup.html b/docs/module-server.ServerViewGroup.html
diff --git a/docs/module-server.Switchboard.html b/docs/module-server.Switchboard.html
diff --git a/docs/module-server.WorkSpace.html b/docs/module-server.WorkSpace.html
diff --git a/docs/module-server.html b/docs/module-server.html
diff --git a/docs/module-shared.Circle.html b/docs/module-shared.Circle.html
diff --git a/docs/module-shared.Hitbox.html b/docs/module-shared.Hitbox.html
diff --git a/docs/module-shared.IdStamper.html b/docs/module-shared.IdStamper.html
diff --git a/docs/module-shared.Item.html b/docs/module-shared.Item.html
diff --git a/docs/module-shared.Oval.html b/docs/module-shared.Oval.html
diff --git a/docs/module-shared.Point2D.html b/docs/module-shared.Point2D.html
diff --git a/docs/module-shared.Polygon2D.html b/docs/module-shared.Polygon2D.html
diff --git a/docs/module-shared.Rectangle.html b/docs/module-shared.Rectangle.html
diff --git a/docs/module-shared.RoundedLine.html b/docs/module-shared.RoundedLine.html
diff --git a/docs/module-shared.View.html b/docs/module-shared.View.html
diff --git a/docs/module-shared.WamsElement.html b/docs/module-shared.WamsElement.html
diff --git a/docs/module-shared.WamsImage.html b/docs/module-shared.WamsImage.html
diff --git a/docs/module-shared.html b/docs/module-shared.html
diff --git a/docs/module-shared.utilities.html b/docs/module-shared.utilities.html
diff --git a/docs/predefined.js.html b/docs/predefined.js.html
diff --git a/docs/predefined_actions.js.html b/docs/predefined_actions.js.html
diff --git a/docs/predefined_items.js.html b/docs/predefined_items.js.html
diff --git a/docs/predefined_layouts.js.html b/docs/predefined_layouts.js.html
diff --git a/docs/predefined_routing.js.html b/docs/predefined_routing.js.html
diff --git a/docs/predefined_utilities.js.html b/docs/predefined_utilities.js.html
diff --git a/docs/scripts/collapse.js b/docs/scripts/collapse.js
diff --git a/docs/scripts/commonNav.js b/docs/scripts/commonNav.js
diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js
diff --git a/docs/scripts/nav.js b/docs/scripts/nav.js
diff --git a/docs/scripts/polyfill.js b/docs/scripts/polyfill.js