Create a library using mdbookshelf

.github/workflows/buildbook.yml

@@ -22,15 +22,20 @@ jobs:
         run: |
           curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.12/mdbook-v0.4.12-x86_64-unknown-linux-gnu.tar.gz | tar -xz -C /usr/local/bin
 
-      - name: Build all books
+      - name: Sync and build bookshelf
         run: |
-          for book in $(find . -name book.toml -exec dirname {} \;); do
-            mdbook build $book
-          done
+          git clone https://github.com/DomtronVox/mdbookshelf.git
+          cd mdbookshelf
+          cargo update
+          cargo build --release
 
-      - name: Upload built books
+      - name: Build ODP bookshelf
+        run: |
+          ./mdbookshelf/target/release/mdbookshelf build
+          cp ./media/* build
+
+      - name: Upload output folder
         uses: actions/upload-artifact@v4
         with:
-          name: built-books
-          path: '**/book'
-          if-no-files-found: error
+          name: Web Folder
+          path: build/

.gitignore

@@ -12,3 +12,6 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# Ignore book output
+book

bookshelf/Shelf 1 Getting Started/overview/book.toml

@@ -0,0 +1,2 @@
+[book]
+title = "Open Device Partnership Overview"

bookshelf/Shelf 1 Getting Started/overview/src/README.md

@@ -0,0 +1,31 @@
+# Open Device Partnership Overview
+![Open Device Partnership](media/odp.png)
+
+## Overview
+An alliance of industry-leading PC ecosystem partners promoting secure, reusable, and trusted system software for client devices
+
+The Open Device Partnership (ODP) is an open-source initiative focused on:
+- Enhancing device security
+- Simplifying cross-architecture development (ARM & x86 standards)
+- Strengthening fundamentals (“raise all boats”)
+- Accelerating the delivery of high-quality devices
+
+Designed from the onset to be inclusive of all device ecosystem partners and stakeholders
+- One stop location for everything needed to build a Windows client device
+- Optimized for Windows devices but only successful if other operating systems can also thrive
+- Open-source under the (MIT) with open governance focused on driving ecosystem innovation
+- Long time-horizon investment (start by meeting partners where they are today)
+
+## Projects
+The following projects are currently in progress. As new areas are identified, they will be incorporated through the ODP governance process.
+
+[![EC Services](media/ec_services.png)](#ec-services-overview)
+[![EC Firmware](media/ec_mcu.png)](#ec-firmware-overview)
+[![Boot Firmware](media/boot.png)](#boot-firmware-overview)
+<br>
+
+## Architectural Overview 
+
+The following diagram shows the various aspects of client devices that ODP contributes samples to.
+
+![ODP Components](media/odp_arch.png)

bookshelf/Shelf 1 Getting Started/overview/src/SUMMARY.md

@@ -0,0 +1,11 @@
+# Summary
+
+[Introduction](README.md)
+
+- [Getting Started](getting-started.md)
+  - [Hardware](hardware.md)
+    - [QEMU](QEMU.md)
+  - [Software](software.md)
+- [Projects](projects.md)
+- [Standards/Specifications](specifications.md)
+- [Tutorials](tutorials.md)

bookshelf/Shelf 1 Getting Started/overview/src/getting-started.md

@@ -0,0 +1,3 @@
+# Getting Started Guide
+
+Place holder for getting started.

bookshelf/Shelf 1 Getting Started/overview/src/hardware.md

@@ -0,0 +1,3 @@
+# Hardware
+
+This is placeholder for discussing supported hardware platforms and tools.

bookshelf/Shelf 1 Getting Started/overview/src/projects.md

@@ -0,0 +1,3 @@
+# Projects
+
+This section discusses each ODP project overview. For detailed information see the book corresponding to each ODP project.

bookshelf/Shelf 1 Getting Started/overview/src/software.md

@@ -0,0 +1,3 @@
+# Software
+
+This is placeholder that discusses tools used for building, debugging and working with ODP projects.

bookshelf/Shelf 1 Getting Started/overview/src/specifications.md

@@ -0,0 +1,3 @@
+# Standards/Specifications
+
+This section discusses publised standards and specifications from ODP.

bookshelf/Shelf 1 Getting Started/overview/src/tutorials.md

@@ -0,0 +1,3 @@
+# Tutorials
+
+This section has tutorial guides as well as links to YouTube channel.

bookshelf/Shelf 2 Projects/Embedded Services/book.toml

@@ -0,0 +1,2 @@
+[book]
+title = "Embedded Controller Services"

bookshelf/Shelf 2 Projects/Embedded Services/src/README.md

@@ -0,0 +1,7 @@
+# Embedded Controller Services Overview
+
+Embedded Controller(EC) services includes all components required to run on application processor.
+- Hafnium EC service
+- EcTest driver and application
+- ACPI sample code
+- UEFI shared memory sample code

bookshelf/Shelf 2 Projects/Embedded Services/src/SUMMARY.md

@@ -0,0 +1,4 @@
+# Summary
+
+[Introduction](README.md)
+