Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update architecture.mdx #124

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

DMontgomery40
Copy link

This pull request updates our Mermaid diagram configuration to ensure the layout is no longer compressed. It fixes overlapping boxes by adjusting subgraph labels and diagram direction, resulting in a more readable flowchart.

Motivation and Context

We needed this change because the previous Mermaid diagram was hard to read—elements were jammed together, making it unclear how components interacted. By modifying the labels and adjusting the layout, we make the diagram easier to understand at a glance.

How Has This Been Tested?

  • Generated multiple variations of the diagram locally to confirm that the subgraphs display in separate boxes.
  • Previewed the diagram on GitHub to ensure it renders correctly without parse or lexical errors.
  • Confirmed that no visual overlap occurs even in smaller viewports.

Breaking Changes

No breaking changes—existing Markdown files remain compatible. We only updated the Mermaid syntax for improved readability.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

@dsp-ant dsp-ant self-requested a review February 3, 2025 21:42
Copy link
Member

@jspahrsummers jspahrsummers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the wrapping fixes! But can you please revert the other changes? I don't think the change to ServerProcess1 and ServerProcess2 adds clarity, and it looks a bit confusing when Mermaid chooses to render them out of order.

client2[MCP Client]
end

subgraph ServerProcess1

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is a good call. We can see in the graph that we are talking about different Server Processes. I don't see the necessity of changing this piece.

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.

3 participants