From 790b9de40996bcb0132591b5ce6e627bd32ec13b Mon Sep 17 00:00:00 2001 From: bfjelds Date: Tue, 26 May 2026 17:33:17 -0700 Subject: [PATCH 1/2] docs: fix mermaid syntax and broken anchor in website build - Convert :::mermaid/:::/admonition syntax to code-fenced mermaid blocks in gRPC-Server.md, Image-Streaming-Pipeline.md, and Public-Docs.md - Fix broken anchor in Rollback-Tests.md: link to #4-download- instead of #4-create- to match Servicing-Tests.md heading Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/Development/Contributing/Documentation/Public-Docs.md | 6 +++--- docs/Development/Testing/Rollback-Tests.md | 4 ++-- docs/Explanation/Image-Streaming-Pipeline.md | 4 ++-- docs/Explanation/gRPC-Server.md | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/Development/Contributing/Documentation/Public-Docs.md b/docs/Development/Contributing/Documentation/Public-Docs.md index f14a56b13..1393c2a09 100644 --- a/docs/Development/Contributing/Documentation/Public-Docs.md +++ b/docs/Development/Contributing/Documentation/Public-Docs.md @@ -55,15 +55,15 @@ When linking to resources, use relative paths to the `/docs/resources` directory Prefer the use of mermaid diagrams embedded in markdown files. This allows for easy editing and version control of diagrams. -```markdown -:::mermaid +````markdown +```mermaid flowchart TD A[Hard] -->|Text| B(Round) B --> C{Decision} C -->|One| D[Result 1] C -->|Two| E[Result 2] -::: ``` +```` ### Internal Links diff --git a/docs/Development/Testing/Rollback-Tests.md b/docs/Development/Testing/Rollback-Tests.md index 4ca55f479..14e6140c9 100644 --- a/docs/Development/Testing/Rollback-Tests.md +++ b/docs/Development/Testing/Rollback-Tests.md @@ -23,7 +23,7 @@ extensions: All image configs live under `tests/images/trident-vm-testimage/base/`. The base image is `qemu_guest` (see -[Servicing Tests — Create the qemu\_guest Base Image](Servicing-Tests.md#4-create-the-qemu_guest-base-image) +[Servicing Tests — Download the qemu\_guest Base Image](Servicing-Tests.md#4-download-the-qemu_guest-base-image) for how to create it from the publicly available `baremetal` image on MCR). **`trident-vm-usr-verity-testimage`** (recommended) uses systemd-boot with a @@ -99,7 +99,7 @@ make artifacts/id_rsa ### 4. Create the qemu\_guest Base Image Follow the instructions in -[Servicing Tests — Create the qemu\_guest Base Image](Servicing-Tests.md#4-create-the-qemu_guest-base-image) +[Servicing Tests — Download the qemu\_guest Base Image](Servicing-Tests.md#4-download-the-qemu_guest-base-image) to download the `baremetal` image from MCR and convert it to `qemu_guest.vhdx` using Image Customizer. diff --git a/docs/Explanation/Image-Streaming-Pipeline.md b/docs/Explanation/Image-Streaming-Pipeline.md index 1e3baf778..b39441a64 100644 --- a/docs/Explanation/Image-Streaming-Pipeline.md +++ b/docs/Explanation/Image-Streaming-Pipeline.md @@ -25,13 +25,13 @@ increase provisioning time. Streaming solves both problems: ## Pipeline Stages -:::mermaid +```mermaid flowchart LR Remote["Remote Source
(HTTP / OCI)"] --> HttpSubFile["HTTP Range
Reader"] HttpSubFile --> Hash["SHA-384
Hasher"] Hash --> Decompress["ZSTD
Decompressor"] Decompress --> Disk["Target
Partition"] -::: +``` ### Remote Source diff --git a/docs/Explanation/gRPC-Server.md b/docs/Explanation/gRPC-Server.md index 78a3111bb..02949fdeb 100644 --- a/docs/Explanation/gRPC-Server.md +++ b/docs/Explanation/gRPC-Server.md @@ -42,14 +42,14 @@ Rust gRPC framework built on top of the Tokio async runtime. The API is defined in Protocol Buffer files under the `proto/` directory and compiled into Rust types by the `trident-proto` crate. -:::mermaid +```mermaid flowchart LR Client["gRPC Client"] -- Unix Socket --> Server["Trident Daemon\n(tridentd)"] Server --> Version["VersionService"] Server --> Streaming["StreamingService"] Server --> Update["UpdateService"] Server --> Commit["CommitService"] -::: +``` ### Unix Domain Socket From 58b543d63b22c9f1b9190721c1a12413013952b0 Mon Sep 17 00:00:00 2001 From: bfjelds Date: Tue, 26 May 2026 18:10:47 -0700 Subject: [PATCH 2/2] docs: fix baremetal -> minimal-os image name in Rollback-Tests The linked Servicing-Tests instructions download the minimal-os image from MCR, not baremetal. Update both references in Rollback-Tests.md to match. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/Development/Testing/Rollback-Tests.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/Development/Testing/Rollback-Tests.md b/docs/Development/Testing/Rollback-Tests.md index 14e6140c9..385fd77ee 100644 --- a/docs/Development/Testing/Rollback-Tests.md +++ b/docs/Development/Testing/Rollback-Tests.md @@ -24,7 +24,7 @@ extensions: All image configs live under `tests/images/trident-vm-testimage/base/`. The base image is `qemu_guest` (see [Servicing Tests — Download the qemu\_guest Base Image](Servicing-Tests.md#4-download-the-qemu_guest-base-image) -for how to create it from the publicly available `baremetal` image on MCR). +for how to download it from the publicly available `minimal-os` image on MCR). **`trident-vm-usr-verity-testimage`** (recommended) uses systemd-boot with a Unified Kernel Image (UKI) and `/usr` dm-verity. This is the only image type @@ -100,8 +100,7 @@ make artifacts/id_rsa Follow the instructions in [Servicing Tests — Download the qemu\_guest Base Image](Servicing-Tests.md#4-download-the-qemu_guest-base-image) -to download the `baremetal` image from MCR and convert it to `qemu_guest.vhdx` -using Image Customizer. +to download the `minimal-os` image from MCR and rename it to `qemu_guest.vhdx`. ### 5. Build Extension Images