-
-
Notifications
You must be signed in to change notification settings - Fork 364
doc(Mermaid): Add doc for Mermaid component #4711
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
Conversation
Reviewer's Guide by SourceryThis PR adds documentation and localization support for a new Mermaid component, which is a tool for creating diagrams using Markdown-inspired text definitions. The implementation includes adding new localization strings, menu entries, and sample code demonstrating basic and styled usage of the component. Class diagram for the new Mermaids componentclassDiagram
class Mermaids {
- MermaidType _options
- Dictionary<MermaidType, string> data
+ AttributeItem[] GetAttributes()
+ MethodItem[] GetMethods()
}
class AttributeItem {
+ string Name
+ string Description
+ string Type
+ string ValueList
+ string DefaultValue
}
class MethodItem {
+ string Name
+ string Description
+ string Parameters
+ string ReturnValue
}
Mermaids --> "1" AttributeItem
Mermaids --> "1" MethodItem
class MermaidType {
<<enumeration>>
None
Flowchart
SequenceDiagram
ClassDiagram
StateDiagram
ErDiagram
Journey
Gantt
Pie
}
Mermaids --> "1" MermaidType
class MermaidDirection {
<<enumeration>>
TB
BT
LR
RL
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Thanks for your PR, @XUEWUQIUSHUANG. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @XUEWUQIUSHUANG - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
src/BootstrapBlazor.Server/Components/Samples/Mermaids.razor.cs
Outdated
Show resolved
Hide resolved
|
@microsoft-github-policy-service agree |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4711 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 620 620
Lines 27382 27382
Branches 3923 3923
=========================================
Hits 27382 27382 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
doc(Mermaid): Add doc for Mermaid component
Summary of the changes (Less than 80 chars)
简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号
Description
doc(Mermaid): Add doc for Mermaid component
Regression?
[If yes, specify the version the behavior has regressed from]
[是否影响老版本]
Risk
[Justify the selection above]
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Documentation: