Docs/specialize micofe

.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Documentation
+
+on:
+ push:
+ branches:
+ - main
+ workflow_dispatch:
+
+# Allow the workflow to deploy to GitHub Pages.
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment.
+concurrency:
+ group: pages
+ cancel-in-progress: false
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Set up Python
+ uses: actions/setup-python@v5
+ with:
+ python-version: '3.12'
+
+ - name: Install dependencies
+ run: pip install --no-cache-dir -r doc/requirements.txt
+
+ - name: Build documentation
+ run: sphinx-build -b html doc/source/ public/
+
+ - name: Upload Pages artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: public
+
+ deploy:
+ needs: build
+ runs-on: ubuntu-latest
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4

.gitignore

@@ -66,3 +66,7 @@ filesystem/work
 
 #TaMPLate files for the man documentation
 !*.tmpl
+
+# GitHub Actions workflows
+!.github
+!.github/**

doc/source/architecture.rst

@@ -0,0 +1,36 @@
+.. _architecture:
+
+Architecture
+############
+
+The overall approach combines the *SOO* mobile entity concept with the *SO3*
+operating system, running on top of the *Agency Virtualizer (AVZ)* hypervisor.
+Micro-services are deployed as **SO3 capsules** — strongly isolated containers
+that run alongside a full Linux environment (the *agency domain*).
+
+.. figure:: img/micofe-architecture.png
+ :name: _fig-architecture
+ :alt: General architecture of the edge environment
+ :width: 720px
+ :align: center
+
+ General architecture of the edge environment
+
+The dashed *MICOFE* rectangle in the figure above highlights the components
+developed as part of the project. With the exception of Rust support — which
+could not be delivered due to time and budget constraints — all other components
+were implemented, tested, and validated.
+
+The main building blocks are:
+
+* The :ref:`EMISO <emiso>` engine, running in the agency domain user space, which
+ manages the lifecycle of the SO3 capsules.
+* :ref:`Portainer <portainer>`, used as the *Container Orchestration User Interface*
+ (COUI), running on the host PC.
+* The :ref:`MUSL libc <syscalls>` runtime and the SO3 syscall layer, which allow
+ standard applications to run unmodified inside capsules.
+* The :ref:`C++ <cpp>` user-space runtime, built on top of the MUSL-aligned C
+ runtime.
+* The :ref:`capsule / LVGL integration <lvgl>`, which gives graphical capsules
+ access to the display through a backend/frontend driver pair and the AVZ
+ hypervisor.