search

MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
135 stars 124 forks source link

Add diagrams for design documents #1247

Closed damithc closed 2 years ago

damithc commented 4 years ago

Suggestion: add some diagrams (e.g., plantUML diagrams) to developer documents to make the design easier to understand but also to showcase MarkBind's inbuilt support for diagramming

damithc commented 4 years ago

I recall seeing someone using puml diagrams to describe MarkBind parser workflow. @ang-zeyu @alyip98 @openorclose was it any of you?

EDIT: found the relevant PR https://github.com/MarkBind/markbind/pull/1224

ang-zeyu commented 4 years ago

put it #1224 on hold for now pending (possibly) a few more refactors. I noticed the page generation activity diagram was far too low-level still as well, which necessitates frequent changes to the dev docs. Aiming to replace that with a somewhat more high level one!

damithc commented 4 years ago

put it #1224 on hold for now pending (possibly) a few more refactors. I noticed the page generation activity diagram was far too low-level still as well, which necessitates frequent changes to the dev docs. Aiming to replace that with a somewhat more high level one!

Makes sense 👍

ang-zeyu commented 2 years ago

closed with #1224