automatically generate screenshots

[jessebot]

Describe the feature you'd like, and why

I'd like a way to automatically generate screenshots for the CLI help, as well as all the TUI screens here:
https://github.com/small-hack/smol-k8s-lab/tree/main/docs/images/screenshots

We can generate the screenshots with rich and textual. We have a hidden feature in smol-k8s-lab for rich here:

smol-k8s-lab/smol_k8s_lab/utils/rich_cli/help_text.py

Line 16 in f753dda

RECORD = False

and here:

smol-k8s-lab/smol_k8s_lab/utils/rich_cli/help_text.py

Lines 130 to 132 in f753dda

	# I use this to print a pretty svg at the end sometimes
	if RECORD:
	console.save_svg("docs/screenshots/help_text.svg", title="term")

We should expose that via the cli, and also add textual screenshots in there as well, as right now, I actually manually generate each of those screenshots and with the amount of screens we support, this is getting a bit too time consuming.

[jessebot]

Ran into a minor snag where the screenshot file name is not predictable, so I've opened Textualize/textual#3795 to kindly ask if this is a feature that can be implemented. In the meantime, I think I can only automate the smol-k8s-lab --help screenshot since rich already provides a way to name the screenshot.

[jessebot]

Created an env var to set to generate the --help docs:

smol-k8s-lab/smol_k8s_lab/utils/rich_cli/help_text.py

Line 18 in f61a92d

RECORD = environ.get("SMOL_SCREENSHOT", False)

davep linked me their useful blog post:
https://blog.davep.org/2023/07/03/making-my-github-banner.html

I've been using it to write a script for our ci jobs:
https://github.com/small-hack/smol-k8s-lab/blob/main/smol_k8s_lab/tui/make_screenshots.py

Also learned about the testing guide 🤯 very useful and makes testing less scary :
https://textual.textualize.io/guide/testing/#snapshot-testing