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

Add flowcharts to aid explanations of processes #335

Open
avivace opened this issue Jul 24, 2021 · 1 comment
Open

Add flowcharts to aid explanations of processes #335

avivace opened this issue Jul 24, 2021 · 1 comment
Labels
content Improvements or additions to documentation enhancement New feature or request figures

Comments

@avivace
Copy link
Sponsor Member

avivace commented Jul 24, 2021

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

@avivace avivace added content Improvements or additions to documentation enhancement New feature or request labels Jul 24, 2021
@ISSOtm
Copy link
Member

ISSOtm commented Jul 24, 2021

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.

  • Is this acceptable?
  • If not:
    • Do we hand-roll our own generator in one of these two languages? (Pro: a custom generator may play better with Redraw PPU timings SVG, can be affected by theme #330.)
    • Do we replace one of our current languages with JS? (Given that getting rid of Rust would require switching to another infrastructure again, the Python script would likely have to be ported.)

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

No branches or pull requests

2 participants