created outline of website

Author: fracpete

.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Build Documentation using MkDocs
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    name: Build and Deploy Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Master
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs==1.4.2 mkdocs-video==1.3.0 jinja2==3.1.2 "Markdown<3.4.0" mkdocs-table-reader-plugin==1.1.0 mkdocs-material==8.5.10
+
+      - name: Deploy
+        run: |
+          git pull
+          mkdocs gh-deploy

.gitignore

@@ -1,6 +1,6 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[codz]
+*.py[cod]
 *$py.class
 
 # C extensions
@@ -20,7 +20,6 @@ parts/
 sdist/
 var/
 wheels/
-share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -39,17 +38,14 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
-.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
-*.py.cover
 .hypothesis/
 .pytest_cache/
-cover/
 
 # Translations
 *.mo
@@ -59,7 +55,6 @@ cover/
 *.log
 local_settings.py
 db.sqlite3
-db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -72,71 +67,22 @@ instance/
 docs/_build/
 
 # PyBuilder
-.pybuilder/
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# UV
-#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#uv.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-#poetry.toml
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
-#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
-#pdm.lock
-#pdm.toml
-.pdm-python
-.pdm-build/
-
-# pixi
-#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
-#pixi.lock
-#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
-#   in the .venv directory. It is recommended not to include this directory in version control.
-.pixi
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
+.python-version
+
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
 # Environments
 .env
-.envrc
 .venv
 env/
 venv/
@@ -156,52 +102,13 @@ venv.bak/
 
 # mypy
 .mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-# Abstra
-# Abstra is an AI-powered process automation framework.
-# Ignore directories containing user credentials, local state, and settings.
-# Learn more at https://abstra.io/docs
-.abstra/
-
-# Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
-#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
-#  you could uncomment the following to ignore the entire vscode folder
-# .vscode/
-
-# Ruff stuff:
-.ruff_cache/
-
-# PyPI configuration file
-.pypirc
-
-# Cursor
-#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
-#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
-#  refer to https://docs.cursor.com/context/ignore-files
-.cursorignore
-.cursorindexingignore
-
-# Marimo
-marimo/_static/
-marimo/_lsp/
-__marimo__/
+
+# other
+*.swp
+*~
+*.bak
+*.sh
+.~lock*
+
+# IDEA IDE config files
+.idea/*

README.md

@@ -1,2 +1,51 @@
 # WAILight.github.io
 Website for the WAILight project.
+
+## Content
+
+The content for the website lives in the [docs](docs) sub-folder and consists
+of [Markdown](https://github.github.com/gfm/) text files. These files need
+to have the extension `.md`.
+
+**NB:** Any modifications or additions that get committed via the web interface
+automatically trigger a rebuild of the site via Github Actions (see 
+[Deploying](#deploying)).
+
+## Modifying
+
+Simply edit the respective page in the web-browser (you need to be logged in 
+into github and be a member of the contributors team). You can do that either
+through the *pen* icon on the web page itself or go to this repo and navigate
+to the correct `.md` file and then click on the *pen* icon there.
+
+## Adding
+
+Adding a page consists of two steps:
+
+* create a new `.md` file in the [docs](docs) sub-folder (the file name should 
+  be all lower-case and contain no spaces - use underscores instead)
+* add this `.md` file in the [mkdocs.yml](mkdocs.yml) configuration file
+  under the `nav` section with a suitable title (the title can contain spaces 
+  and doesn't have to be all lower-case).
+  
+
+## Local
+
+### Installation
+
+```bash
+python3 -m venv venv
+./venv/bin/pip install mkdocs==1.4.2 mkdocs-video==1.3.0 jinja2==3.1.2 "Markdown<3.4.0" mkdocs-table-reader-plugin==1.1.0 mkdocs-material==8.5.10
+```
+
+### Serving
+
+```bash
+./venv/bin/mkdocs serve
+```
+
+## Deploying
+
+Any push will trigger a rebuild of the site on github via github actions:
+
+[.github/workflows/main.yml](.github/workflows/main.yml)

docs/files/.gitignore

@@ -0,0 +1 @@
+*Under construction*

docs/hardware.md

@@ -0,0 +1,7 @@
+![WAILight rig in action](img/logo.jpg)
+
+Welcome to the WAILight project.
+
+# Publications
+Explore our [publications](publications.md) to access the detailed findings and 
+contributions from our team. 

docs/img/.gitignore

@@ -0,0 +1,6 @@
+# 2025
+
+* Abeysekera S, Ooi MP-L, Kuang Y-C, Faisal S, Thawdar Y, Holmes G, Fletcher D, 
+  Reutemann P, 2025. *Rethinking the Concept of Pixel Intensity Contrast From 
+  a Machine Learning Perspective.* IEEE Sensors Letters, 9(12):1-4, IEEE.
+  [10.1109/lsens.2025.3627240](https://dx.doi.org/10.1109/lsens.2025.3627240)