Add Mermaid architecture diagrams to README#535
Merged
ericsciple merged 1 commit intomainfrom Dec 5, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds Mermaid-based architecture diagrams to the README to provide a visual overview of the extension's architecture. The diagrams complement the existing detailed architecture documentation in docs/project-architecture.md by offering an at-a-glance understanding of the system's components and relationships.
- Adds two Mermaid diagrams: a high-level architecture overview and a key components diagram
- Includes a helpful comment directing users to install the "Markdown Preview Mermaid Support" extension for VS Code
- Uses color coding to highlight different component types (extension, language server, GitHub API, authentication, management, validation)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
135fe2e to
3401e2b
Compare
salmanmkc
approved these changes
Dec 5, 2025
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
2 participants
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.
👉 Rendered 👈