Could use some more (or better?) examples of how this can be useful.
In some of my projects I have little snippets of cli commands in the main README.
When I open the project in JetBrains IDE and I open the README of my project there, I can click on each code block to run it.
This way I can for example start up dependencies like say a little python3 web server to serve static files from one of the subdirs, simply by clicking on it in the readme. Instead of copy-pasting from the readme, and even instead of Ctrl+R in a terminal window and finding the correct commands for a project from history.
It almost reminds me a little bit of Plan9 and their Acme editor, where they were blurring the lines between text and commands. In Acme you can type a piece of text and then middle-button click I think it was to run the text as a command. Having executable blocks of code interspersed in a markdown document feels a little bit like that although in a different, more limited manner.
It was like a super rudimentary Jupyter Notebook system of my own making.
Eventually I switched away from my own run-and-insert system.
It's all open source. Please get involved! We'd be happy to have you.
We could expect failure conditions or assert correct outcomes.
It could become a little library of examples that change over time, as the software changes, granting us peace of mind that everything still works.