Skip to content

Conversation

@gerteck
Copy link
Member

@gerteck gerteck commented Dec 15, 2025

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:

Removed mermaid diagram from previous added PR #2753 as DG does not support mermaid plugin.
Raised an issue for that.
Replaced it with a png image.

Anything you'd like to highlight/discuss:

Nil

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Update dev guide for team management


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

@gerteck
Copy link
Member Author

gerteck commented Dec 15, 2025

Original mermaid diagram is:

<mermaid>
flowchart LR
    %% Entry Points
    New[New Contributor] -->|Consistent Contribution| Active[active-contributors]

    %% Developer Path
    Active -->| | JrDev[junior-developers]
    JrDev -->|Demonstrated Expertise| SrDev[senior-developers]

    %% Leadership Path
    SrDev -->|Leadership Role| Leads[team-leads]
    SrDev -->|Release Management| RM[release-manager-admins]

    subgraph Maint [Maintainers Group]
        direction TB
        Leads
        RM
    end

    subgraph Devs [Developers Group]
        direction TB
        JrDev
        SrDev
    end

    %% Styling
    style New fill:#fff,stroke:#333,stroke-dasharray: 5 5
    style Active fill:#e1f5fe,stroke:#01579b
    style JrDev fill:#fff9c4,stroke:#fbc02d
    style SrDev fill:#fff9c4,stroke:#fbc02d
    style Leads fill:#ffebee,stroke:#b71c1c
    style RM fill:#ffebee,stroke:#b71c1c
    style Maint fill:#ffebee,stroke:#b71c1c,stroke-dasharray: 5 5
    style Devs fill:#fff9c4,stroke:#fbc02d,stroke-dasharray: 5 5
</mermaid>

When dev guide mermaid plugin enabled, can replace the picture with the mermaid code again. Otherwise, not doing so is okay too. Just putting it here for reference.

@codecov
Copy link

codecov bot commented Dec 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.65%. Comparing base (cd78196) to head (c867b7b).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #2756    +/-   ##
========================================
  Coverage   61.65%   61.65%            
========================================
  Files         130      130            
  Lines        7167     7167            
  Branches     1593     1481   -112     
========================================
  Hits         4419     4419            
- Misses       2558     2685   +127     
+ Partials      190       63   -127     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@gerteck gerteck changed the title Update docs for team management Remove mermaid diagram from dev docs for team management Dec 15, 2025
@gerteck gerteck mentioned this pull request Dec 15, 2025
14 tasks
@gerteck gerteck merged commit b4bdc35 into MarkBind:master Dec 15, 2025
11 of 13 checks passed
@gerteck gerteck deleted the doc/teamManagement2 branch December 15, 2025 19:34
@github-actions github-actions bot added the r.Patch Version resolver: increment by 0.0.1 label Dec 15, 2025
@damithc
Copy link
Contributor

damithc commented Dec 17, 2025

@gerteck Isn't it better to keep the diagram in source format and enable the plugin? Otherwise it will be harder to update the diagram later.

@gerteck
Copy link
Member Author

gerteck commented Dec 17, 2025

@gerteck Isn't it better to keep the diagram in source format and enable the plugin? Otherwise it will be harder to update the diagram later.

Yes, I agree, I opened #2755 to enable the mermaid plugin to dev guide, to be done before replacing it with the mermaid source code, as I was worried that there were extra steps for the CI.

But I just realized it will just be a one line change in dg-site.json, so I could have just updated it directly 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

r.Patch Version resolver: increment by 0.0.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants