For now you could start by writing files in Markdown. A special index file would point to all the markdown files. We don’t need to be strict about formatting in this stage. Sphinx needs to be incorporated into the CMake build process. That will take me a few days, so I will leave it on hold for now.
There plenty tutorials online for it’s a very simple language. Markdown does support images. Here’s an example of that from Imaginary Teleprompter’s readme:
In web design we usually set a folder aside for images. We could have an images folder inside of the documentation folder, like this:
/docs
/docs/images
When it comes to sub-pages, it could be done in two ways:
/docs/sub-page
/docs/images
or
/docs/sub-page
/docs/sub-page/images
I’d go for the first approach for pictures that could be used more than once, and the second approach for images that wouldn’t be used outside of the sub-page’s context.
I haven’t gotten to it yet. This weekend I started a new prototype for testing the multi-screen feature in combination with the latest version of a framework that I plan on using for an alternate UI. It’s far from done, but I’ll pause and take on this when I get really stuck. Sometimes it’s hard for me to tell when I’m really stuck or just not trying hard enough.
It’s a UI that separates the editor from the prompter, made using KDDockWidgets instead of Kirigami. It’s not meant to replace QPrompt’s Kirigami interface but to provide a more efficient workflow for in-studio use.
Here’s a screenshot of what it looked like when I paused working on it:
It is. The tricky part is to restructure the code so docks can communicate with each other in that version, while the Kirigami version continues to work. It’s not too difficult to achieve, but I do question if it’s worth the effort, since Kirigami can’t run on the iPad. It would probably take me less time to recreate QPrompt in Flutter than to port all the KDE frameworks over… Having said that, porting the frameworks would be better for the KDE ecosystem.
What I meant is that porting the frameworks would enable KDE developers to port their apps over to Apple’s mobile ecosystem. The benefit would go beyond QPrompt.