Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 3, 2025

Fix Mermaid sequence diagram rendering in documentation

This PR addresses the issue where the architecture.md sequence diagram is not being rendered on the docs website (https://microsoft.github.io/wassette/design/architecture.html).

Root Cause: The mdBook configuration lacked the mdbook-mermaid preprocessor, which is required to render Mermaid diagrams.

Changes Made:

  • Explore repository and confirm the issue
  • Add mdbook-mermaid preprocessor configuration to docs/book.toml
  • Update GitHub Actions workflow to install and use mdbook-mermaid
  • Test the documentation build locally
  • Verify the rendered output shows the diagram correctly
  • Update CHANGELOG.md with the fix
  • Exclude mermaid files from spell check CI

Technical Details:

  1. Added [preprocessor.mermaid] configuration to docs/book.toml
  2. Added mermaid.min.js and mermaid-init.js files to docs directory (auto-generated by mdbook-mermaid install)
  3. Updated GitHub Actions workflow to download and install mdbook-mermaid v0.14.0
  4. Updated .gitignore to exclude mdbook and typos binaries
  5. Added mermaid.min.js and mermaid-init.js to typos spell check exclusion list in _typos.toml

Screenshot of Rendered Diagram:

Architecture Diagram

The sequence diagram now renders properly as an interactive Mermaid diagram instead of showing raw code.

Original prompt

This section details on the original issue you should resolve

<issue_title>The architecture.md is not rendered as a sequence diagram on the docs website</issue_title>
<issue_description>https://microsoft.github.io/wassette/design/architecture.html still shows unrendered sequence diagram code.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #323

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Fix sequence diagram rendering in architecture documentation Fix Mermaid sequence diagram rendering in documentation Oct 3, 2025
Copilot AI requested a review from Mossaka October 3, 2025 21:14
Copilot finished work on behalf of Mossaka October 3, 2025 21:14
@Mossaka Mossaka marked this pull request as ready for review October 3, 2025 21:27
@Mossaka Mossaka force-pushed the copilot/fix-sequence-diagram-rendering branch from 3239827 to aed5d49 Compare October 3, 2025 21:28
@Mossaka
Copy link
Collaborator

Mossaka commented Oct 3, 2025

@copilot it looks like the spell check CI failed. Can you ignore the files for mermaid in the spell check CI since we don't own those files?

Copy link
Contributor Author

Copilot AI commented Oct 3, 2025

@copilot it looks like the spell check CI failed. Can you ignore the files for mermaid in the spell check CI since we don't own those files?

Added mermaid files to the spell check exclusion list in _typos.toml. The files **/mermaid.min.js and **/mermaid-init.js are now excluded from typos spell checking. Commit: 8dc5a2f

Copilot finished work on behalf of Mossaka October 3, 2025 21:42
Copilot AI requested a review from Mossaka October 3, 2025 21:42
@Mossaka
Copy link
Collaborator

Mossaka commented Oct 3, 2025

@copilot display the visual change one more time for me to verify if they are working

Copy link
Contributor Author

Copilot AI commented Oct 3, 2025

@copilot display the visual change one more time for me to verify if they are working

Here's the rendered Mermaid sequence diagram showing the architecture flow:

Architecture Diagram

The diagram now renders properly as an interactive Mermaid sequence diagram, showing the complete flow:

  • Component loading from OCI registries, local files, and HTTP URLs
  • WebAssembly compilation and WIT interface extraction
  • Component registration with JSON schema generation
  • Policy application and WASI state creation
  • Tool execution with security policy enforcement

Copilot finished work on behalf of Mossaka October 3, 2025 22:08
@Mossaka Mossaka merged commit 9bd0654 into main Oct 3, 2025
18 checks passed
@Mossaka Mossaka deleted the copilot/fix-sequence-diagram-rendering branch October 3, 2025 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The architecture.md is not rendered as a sequence diagram on the docs website

2 participants