Add project documentation mdBook

.github/workflows/docs.yml

@@ -0,0 +1,61 @@
+name: Documentation
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - "docs/**"
+      - ".github/workflows/docs.yml"
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - ".github/workflows/docs.yml"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build mdBook
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+
+      - name: Install mdBook
+        run: cargo install mdbook --version 0.5.4 --locked
+
+      - name: Build documentation
+        run: mdbook build docs
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/book
+
+  deploy:
+    name: Deploy GitHub Pages
+    if: github.event_name == 'push' && github.repository_owner == 'OpenDevicePartnership'
+    needs: build
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+      pages: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

.gitignore

@@ -2,6 +2,7 @@
 # will have compiled files and executables
 /debug
 **/target
+/docs/book/
 
 # These are backup files generated by rustfmt
 **/*.rs.bk

README.md

@@ -107,6 +107,18 @@ CI lives under `.github/workflows/`:
 - `nostd.yml` — verifies `platform-common` and `dev-*` remain `no_std`-clean.
 - `benchmark.yml`, `rolling.yml` — secondary lanes (binsize tracking on
   `dev-imxrt`/`dev-npcx`; nightly dep update verification).
+- `docs.yml` — builds the project mdBook and publishes it to GitHub Pages
+  after documentation changes land on `main`.
+
+## Documentation
+
+Project documentation, including the Embedded Controller Interface
+specification, is maintained as an [mdBook](./docs/README.md). Build it
+locally with:
+
+```
+mdbook serve docs --open
+```
 
 ## Contributing
 

docs/README.md

@@ -0,0 +1,22 @@
+# ODP Embedded Controller documentation
+
+This directory contains the project-level mdBook described by
+[ODP RFC 0044](https://github.com/OpenDevicePartnership/governance/blob/main/rfc/0044-documentation-philosophy.md).
+
+To build and review the book locally:
+
+```text
+mdbook serve docs --open
+```
+
+To perform a one-time build:
+
+```text
+mdbook build docs
+```
+
+The generated site is written to `docs/book/`.
+
+The EC interface specification was migrated from the
+[ODP documentation repository](https://github.com/OpenDevicePartnership/documentation/tree/main/guide_book/src/specs)
+at commit `0a6b5cf70ddd1e90280d575a485184a3c1e2fd30`.

docs/book.toml

@@ -0,0 +1,15 @@
+[book]
+authors = ["Open Device Partnership"]
+language = "en"
+src = "src"
+title = "ODP Embedded Controller"
+
+[build]
+build-dir = "book"
+
+[output.html]
+git-repository-url = "https://github.com/OpenDevicePartnership/odp-embedded-controller"
+edit-url-template = "https://github.com/OpenDevicePartnership/odp-embedded-controller/edit/main/docs/{path}"
+
+[output.html.fold]
+enable = true

docs/src/SUMMARY.md

@@ -0,0 +1,22 @@
+# Summary
+
+[Introduction](introduction.md)
+
+- [Development](development.md)
+  - [Supply-chain auditing](supply-chain.md)
+- [Specifications](specs/specifications.md)
+  - [Embedded Controller Interface](specs/ec_interface/ec_interface.md)
+    - [EC SoC Interface](specs/ec_interface/ec-soc-interface.md)
+    - [Legacy EC Interface](specs/ec_interface/legacy-ec-interface.md)
+    - [Secure EC Services Overview](specs/ec_interface/secure-ec-services-overview.md)
+    - [EC Firmware Management](specs/ec_interface/ec-firmware-management.md)
+    - [EC Power Service](specs/ec_interface/ec-power-service.md)
+    - [Battery Service](specs/ec_interface/battery-service.md)
+    - [Thermal Service](specs/ec_interface/thermal-service.md)
+    - [UCSI Interface](specs/ec_interface/ucsi-interface.md)
+    - [EC Input Management](specs/ec_interface/ec-input-management.md)
+    - [EC Time Alarm Service](specs/ec_interface/ec-time-alarm-service.md)
+    - [EC Debug Service](specs/ec_interface/ec-debug-service.md)
+    - [EC Manufacturing Service](specs/ec_interface/ec-manufacturing-service.md)
+    - [EC OEM Service](specs/ec_interface/ec-oem-service.md)
+    - [Sample System Implementation](specs/ec_interface/sample-system-implementation.md)

docs/src/development.md

@@ -0,0 +1,9 @@
+# Development
+
+Project development instructions are maintained in the
+[repository README](https://github.com/OpenDevicePartnership/odp-embedded-controller).
+
+The following guides cover processes that require more detail than the main
+README:
+
+- [Supply-chain auditing](supply-chain.md)

docs/src/introduction.md

@@ -0,0 +1,13 @@
+# ODP Embedded Controller
+
+This book documents the public reference and demonstration firmware for
+embedded controllers built with Open Device Partnership components.
+
+The repository contains shared platform support and development targets for
+NXP i.MXRT685S, NXP MCXA266, Nuvoton NPCX498M, and the QEMU RISC-V `ec`
+machine. See the
+[repository README](https://github.com/OpenDevicePartnership/odp-embedded-controller)
+for build instructions and platform details.
+
+The book is maintained with the source code in accordance with
+[ODP RFC 0044](https://github.com/OpenDevicePartnership/governance/blob/main/rfc/0044-documentation-philosophy.md).