Create Documentation Website

Author: jaswch

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1 @@
+venv

docs/Hardware Setup.md

@@ -0,0 +1,17 @@
+## Requirements
+1. LILYGO TQT Pro
+2. USB-C cable
+3. 3mm LED (White colour)
+4. Small speaker
+5. MPU6050 accelerometer
+6. Stemma qt connector
+7. A computer with PlatformIO installed
+8. LiPo battery
+9. JST connector (optional)
+
+## Hardware setup
+1. Solder a white coloured LED to IO33 and 34 with the ground pin soldered on IO34
+2. Solder a speaker to GND and IO16
+3. Solder a JST connector (included in the TQT Pro's box) to the battery charge pads on the microcontroller or directly solder the battery to the pads
+4. Solder a Stemma qt connector to the MPU6050
+5. Connect the Stemma qt connector to the TQT Pro

docs/Release Notes.md

@@ -0,0 +1,14 @@
+## V0.3.3
+OpenTimeWatch Configurator tool can now configure board settings. 
+## V0.3.2
+New OpenTimeWatch Configurator tool.
+## V0.3.1
+otwUI bug fix, updated configuration for TQT pro N8 in ```platformio.ini``` file and better documentation.
+## V0.3.0
+New UI (created using [lopaka.app](https://lopaka.app/sandbox)), multiple watch faces, Wifi support, time synchronisation, back option in menus, accelerometer support and apps and sub menus separated from the ```main.cpp``` file.
+## V0.2.1
+Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
+## V0.2.0
+A significant update compared to V0.1, as it introduced menus, pong, interaction with peripherals (torch and speaker), OS being open sourced, matrix effect, settings menu. 
+## V0.1.0
+The initial release it just had a home screen and an about screen.

docs/index.md

@@ -0,0 +1,4 @@
+# Welcome to OpenTimeWatch Project
+
+It is a project which involves building open source hardware and software for smartwatches
+

mkdocs.yml

@@ -0,0 +1,27 @@
+site_name: OpenTimeWatch Docs
+site_url: https://sitename.example
+theme:
+  name: material
+  font:
+    code: Red Hat Mono
+  palette:
+    # Dark Mode
+    - scheme: slate
+      toggle:
+        icon: material/weather-sunny
+        name: Dark mode
+      primary: lime
+      accent: deep purple
+
+    # Light Mode
+    - scheme: default
+      toggle:
+        icon: material/weather-night
+        name: Light mode
+      primary: lime
+      accent: deep purple
+markdown_extensions:
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg