docs: sync mermaid class diagram perfectly with png model#11
Merged
Conversation
|
@techatanu is attempting to deploy a commit to the Yug's projects Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
Updates the Sentinel class diagram documentation to include an embedded PNG and an “interactive” Mermaid class diagram intended to match the image model.
Changes:
- Added a new embedded diagram image reference (
class-diagram.png) and replaced the old diagram section. - Added a full Mermaid
classDiagramsource to the document. - Updated the overview bullets describing the diagram’s major components.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Providers**: Abstractions for interacting with external AI runtimes like `OllamaClient`. | ||
|
|
||
| *The above diagram provides a visual high-level overview of the OOP structure.* | ||
| *The interactive diagram provides a visual high-level overview of the OOP structure, avoiding the need for external image files.* |
Comment on lines
+230
to
+233
| - **Interface Layer**: Classes responsible for user interactions (`CLIHandler`, `WebAPIHandler`). | ||
| - **Core Agent**: The central orchestration classes managing file scanning, classification, AI planning, safety validation, and execution operations (`SentinelOrchestrator` and its dependencies). | ||
| - **Data Models**: The structural representation of data entities handling files, action plans, and execution logs. | ||
| - **Providers**: Abstractions for interacting with external AI runtimes like `OllamaClient`. |
|
|
||
| This document provides a class diagram illustrating the Object-Oriented design and structure of the Sentinel application. | ||
|
|
||
|  |
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.
No description provided.