docs: fix mermaid syntax and broken anchor in website build#664
Merged
Conversation
- 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>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Trident’s Docusaurus documentation to eliminate website-build warnings by migrating Mermaid diagrams to Docusaurus 3.x’s expected fenced-code-block format and by fixing a broken internal anchor reference.
Changes:
- Convert Mermaid diagrams from
:::mermaiddirectives to fenced ```mermaid code blocks in explanation docs. - Update the Mermaid example in the public docs standards to use nested fences correctly.
- Fix broken links in rollback testing docs to target the correct Servicing Tests heading anchor.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/Explanation/Image-Streaming-Pipeline.md | Converts the Mermaid diagram to a fenced ```mermaid block for Docusaurus 3.x. |
| docs/Explanation/gRPC-Server.md | Converts the Mermaid architecture diagram to a fenced ```mermaid block for Docusaurus 3.x. |
| docs/Development/Testing/Rollback-Tests.md | Fixes the Servicing Tests step-4 anchor used by rollback docs (and related link text). |
| docs/Development/Contributing/Documentation/Public-Docs.md | Updates the Mermaid example to use nested fences (````markdown) correctly. |
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>
frhuelsz
approved these changes
May 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes all warnings from the
website-buildDocusaurus build:Mermaid directive warnings (3 files)
Docusaurus 3.x expects mermaid diagrams in code-fenced blocks rather than admonition-style
:::mermaid/:::directives. Converted:docs/Explanation/gRPC-Server.mddocs/Explanation/Image-Streaming-Pipeline.mddocs/Development/Contributing/Documentation/Public-Docs.md(example block)Broken anchor (1 file)
docs/Development/Testing/Rollback-Tests.mdlinked toServicing-Tests.md#4-create-the-qemu_guest-base-image, but the actual heading in Servicing-Tests.md is "4. Download the qemu_guest Base Image". Updated both references to use the correct anchor#4-download-the-qemu_guest-base-image.Verification
Website build completes with zero warnings after these changes.