Add basic structure

.github/workflows/mkdocs.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

README.md

@@ -0,0 +1,2 @@
+# Project MagNET Documentation
+

docs/docs/architecture/general_architecture.md

@@ -0,0 +1,24 @@
+# General Architecture
+
+
+## Device types
+
+Controller
+
+Gateway 
+
+Consumer
+
+Prosumer
+
+## Architecture
+
+Weak Federation 
+
+Tight Federation - Critical services must not get down
+
+## Bill of Service (BoS)
+
+Uses Bonjour or Avahi Zeroconf advertisement of services in a network stack, and build the Bill of Services, so devices can assign to those services, or require it as they need it.
+
+## Seemless transfer - network sharing

docs/docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to Project MagNET
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

docs/mkdocs.yml

@@ -0,0 +1,20 @@
+site_name: Project MagNET
+nav:
+  - 'index.md'
+  - 'Architecture': 
+    - 'General Architecture': 'architecture/general_architecture.md'
+    - 'Nodes': 'architecture/nodes.md'
+    - 'Nodes': 'architecture/controller.md'
+    - 'Gateway': 'architecture/gateway.md'
+    - 'Consumer': 'architecture/consumer.md'
+    - 'Prosumer': 'architecture/prosumer.md'
+    - 'Data Sink':
+      - 'Introduction': 'architecture/data_sink/data_sink.md'
+  - 'Use Cases':
+    - 'Energy': use_cases/energy.md
+    - 'Autonomous Agents': use_cases/autonomous_agents.md
+    - 'Smart Home': use_cases/smart_home.md
+
+
+
+theme: readthedocs