gbdev / pandocs

The single, most comprehensive Game Boy technical reference.
https://gbdev.io/pandocs/
Creative Commons Zero v1.0 Universal
614 stars 93 forks source link

Add flowcharts to aid explanations of processes #335

Open avivace opened 3 years ago

avivace commented 3 years ago

E.g. Object Priority and Conflicts, currently being reworked by #331

ISSOtm commented 3 years ago

I think that it's a better idea to generate those flowcharts from more usable data, rather than drawing them by hand (either using an editor program, or by hand like a madman).

A quick search yields diagrams, powered by flowchart.js, which looks serviceable enough. [NB: I also found mermaid and mdbook-mermaid, but I rejected them because they run client-side.]

Now, I'm wary of introducing too many build dependencies into Pan Docs, since we already have Rust (mdBook + "plug-ins") and Python (MBC graph generation), and this would add Node/JS to the list.