feat(mermaid) - impement entities doc with mermaid class diagram

[maikmb]

Fixes #

38

24

Proposed Changes

1. Implement a new section "Entities" do view the doc
2. Implement Mermaid class diagram for entities

Readiness Checklist

Author/Contributor

• [X] If documentation is needed for this change, has that been included in this pull request
• [X] Remember to check if code coverage decrease, if so, please implement the necessary tests

Reviewing Maintainer

• [X] Label as breaking if this is a large fundamental change
• [ ] Label as either automation, bug, documentation, enhancement, infrastructure, or performance

[codecov[bot]]

Codecov Report

Merging #47 (900da08) into main (7ccf807) will increase coverage by 1.79%. The diff coverage is 97.87%.

@@            Coverage Diff             @@
##             main      #47      +/-   ##
==========================================
+ Coverage   95.45%   97.24%   +1.79%     
==========================================
  Files           8        9       +1     
  Lines          66      109      +43     
==========================================
+ Hits           63      106      +43     
  Misses          3        3              

Impacted Files	Coverage Δ
src/template/components/navBar.js	100.00% <ø> (ø)
src/entity2diagram.js	97.43% <97.43%> (ø)
src/shelf.js	94.73% <100.00%> (+0.61%)	:arrow_up:
src/template/default.js	100.00% <100.00%> (+5.00%)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 1d132b9...900da08. Read the comment docs.

[jhomarolo]

@maikmb could you please add some print screens?

[italojs]

@maikmb could you update the herbs.github.io please?

[maikvortx]

Hello guys!

@jhomarolo I will implement the new version of herbsshelf in a big project and them I will post some print screens for you. @italojs I will update the doc in another PR.

[maikvortx]

@jhomarolo What do you think about it?

https://github.com/herbsjs/herbsshelf/issues/38#issuecomment-1174549539

[dalssoft]

@maikmb

(1) is is possible to centralize the graph?

(2) Can we change the text?

"Model Diagram" -> "Entities"

"The easiest way to explore your model in herbs projects, undertand your data by browsing across entities and their relations with safety." -> "Explore and learn more about {project name} through its entities and relationships."

[maikmb]

@dalssoft Done!

[jhomarolo]

Great PR @maikmb!

[herbsjs-robot]

:tada: This PR is included in version 4.0.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket:

[dalssoft]

amazing PR! that's the spirit! tks @maikmb !!!