Skip to content

Commit 3deed54

Browse files
docs(Common): Improve Mermaid diagram styling and consistency
Updated the Mermaid diagram in the README to use capitalized class names (e.g., 'Mountain', 'Common') for consistency and improved the labeling by using backticks for code elements and the crate name. This enhances the diagram's readability and aligns with the project's documentation standards, ensuring clear communication of the `Common` crate's architecture and its relationship with consumers like `Mountain`. The changes maintain the core representation of: 1. The abstract traits (`FileSystemReader`), `ActionEffects`, and DTOs defined in `Common` 2. The dependency relationship between Effects and Traits 3. `Mountain`'s role as the primary implementer of `Common` traits 4. Test consumers' relationship to the core architecture This documentation refinement follows recent refactoring work on effect dependencies (5adcc5e) and architecture updates (926b00c).
1 parent 926b00c commit 3deed54

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -148,22 +148,22 @@ it.
148148

149149
```mermaid
150150
graph LR
151-
classDef mountain fill:#f9f,stroke:#333,stroke-width:2px;
152-
classDef common fill:#cfc,stroke:#333,stroke-width:1px;
153-
classDef consumer fill:#9cf,stroke:#333,stroke-width:2px;
151+
classDef Mountain fill:#f9f,stroke:#333,stroke-width:2px;
152+
classDef Common fill:#cfc,stroke:#333,stroke-width:1px;
153+
classDef Consumer fill:#9cf,stroke:#333,stroke-width:2px;
154154
155-
subgraph "The `Common` Crate"
155+
subgraph "The \`Common\` Crate"
156156
direction LR
157-
Traits["Abstract Traits (e.g., `FileSystemReader`)"]:::common
158-
Effects["ActionEffects (e.g., `ReadFile`)"]:::common
159-
DTOs["Data Transfer Objects (e.g., `FileTypeDTO`)"]:::common
157+
Traits["Abstract Traits (e.g., \`FileSystemReader\`)"]:::Common
158+
Effects["ActionEffects (e.g., \`ReadFile\`)"]:::Common
159+
DTOs["Data Transfer Objects (e.g., \`FileTypeDTO\`)"]:::Common
160160
161161
Effects -- Depend on --> Traits
162162
end
163163
164164
subgraph "Consumers"
165-
Mountain[**Mountain Application**]:::mountain
166-
Tests[Unit & Integration Tests]:::consumer
165+
Mountain[**Mountain Application**]:::Mountain
166+
Tests[Unit & Integration Tests]:::Consumer
167167
end
168168
169169
Mountain -- Implements --> Traits

0 commit comments

Comments
 (0)