GMLC-TDC
Add Trouble-Shooting Guide
User Guide page with list of trouble-shooting techniques, such as check log files, make a query, etc.
This would likely be a part of (or effectively provide instruction on using) the web interface
Instead of the typical static page for the web interface user guide, what if instead we "scraped" or otherwise got a dump of the web interface pages from helics_cli with some dummy/example data (I think this part could be automated or scripted more easily than automated updates of images/videos), and made it a semi-interactive tour?
Something like https://shepherdjs.dev/ could be used to create the tour; their homepage is also a demo that shows some of what it can do.
I like the idea of dynamically generated images but don't we need supporting explanations of what the buttons and widgets do? And for the web interface in particular I see demonstration videos showing how to use it being very helpful.
What I'm suggesting is a bit different from dynamically generated images. I think the tour on https://shepherdjs.dev/ does a good job of showing how it gives supporting explanations for buttons/widgets, while also visually directing the attention of a user towards the things that matter in a way that screenshots can't (at least not without much more editing than we currently do). We'd basically have a "static" html version of the web interface, with a tour calling out what matters using shepherdjs.
Demo videos would be helpful, and I think they can do a good job at directing attention to what matters on the screen. It's just unfortunate that what a user sees can vary with different browsers/sizes/dark mode, and changes to the web interface will make them get outdated. https://github.com/mifi/editly/issues/93 has some interesting ideas for automatically generating updated videos.
Actually, I just had another idea -- an interactive tour could be included as part of a help feature built into the web interface, so a user could have a running co-simulation with the web interface open and click a help button that directs them at documentation and gives a tour of the web interface with their data on their own device/browser.
I could totally see the tour of the web interface working using something like "shepherdjs". Is that something we can add into RTD?