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

doc(MindMap): add how to use section #5018

Merged
merged 3 commits into from
Jan 2, 2025
Merged

doc(MindMap): add how to use section #5018

merged 3 commits into from
Jan 2, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 2, 2025

add how to use section

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5017

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add usage instructions to the MindMap component documentation.

Enhancements:

  • Improved the export functionality of the MindMap component by removing redundant export methods and clarifying the messages displayed after export actions.

Documentation:

  • Added a how-to-use section to the MindMap documentation, including instructions on drawing and importing mind maps, and how to use the Data parameter to render the mind map.

Copy link

sourcery-ai bot commented Jan 2, 2025

Reviewer's Guide by Sourcery

This PR adds a "How to use" section to the MindMap documentation and refactors some sample code.

Class diagram for MindMap component changes

classDiagram
    class MindMaps {
        -MindMap MindMap
        +ExportImage() Task
        +ExportJson() Task
        +GetFullData() Task
        +GetData() Task
        +SetData() Task
        +Scale(float step) Task
        +SetSample1() Task
        +SetSample2() Task
    }
    note for MindMaps "Removed _data field and ExportPng method
Renamed Sample1/2 to SetSample1/2"
Loading

File-Level Changes

Change Details Files
Added a how-to-use section to the MindMap documentation.
  • Included steps for drawing and importing mind maps.
  • Added a link to an online mind map tool.
  • Provided instructions on how to use the Data parameter to render the mind map in the component.
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor
Refactored sample code for the MindMap component.
  • Renamed Sample1 and Sample2 methods to SetSample1 and SetSample2 for clarity.
  • Removed unused _data variable.
  • Simplified the GetData method.
  • Updated button click handlers to use the new method names.
  • Removed redundant ExportPng method and updated messages in ExportImage and ExportJson methods.
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor.cs
Minor updates to button styling in Dialogs component examples.
  • Added missing closing tags to Button components for consistent styling.
src/BootstrapBlazor.Server/Components/Samples/Dialogs.razor
Updated localization files and project file.
  • Updated localization files to reflect changes in the MindMap documentation and sample code.
  • Modified project file to include updated dependencies or resources, if any.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5017 Add sample code for MindMap component
#5017 Document how to use the MindMap component

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jan 2, 2025
@bb-auto bb-auto bot added this to the v9.0.0 milestone Jan 2, 2025
@ArgoZhang ArgoZhang merged commit e11e52f into main Jan 2, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the doc-mindmap branch January 2, 2025 01:11
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - 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: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a7617a2) to head (05d830b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5018   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27946     27946           
  Branches      4003      4003           
=========================================
  Hits         27946     27946           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(MindMap): add how to use section
1 participant