[FEATURE] Param in subitems.json to specify link to setup guide

[moodeaudio]

Describe the solution you'd like

A parameter in the subitems.json file for specifying a link to a Setup Guide. This would help inform users what is required for prepping the image.

Example:

"setup_guide": "https://github.com/moode-player/moode/blob/develop/www/setup.txt"

[tdewey-rpi]

I've took a quick look through your setup guide, and must commend you immediately for creating a comprehensive setup document - this attention to the initial user experience is definitely something I'm thankful for.

I do wonder, however, if we couldn't try and offer something more useful. I noticed that your image flash essentially mandates setting up a SSH user through customisation - something we don't enforce in Imager and lack the levers for today.

Would you like to see additional schema changes to cover mandatory customisation fields?

[moodeaudio]

Mandatory fields would help reduce trouble reports due to man's natural inclination to not read setup guides but displaying a link to setup guide would also be useful for those that wish to view it before writing the image.

Something like below

"readme": ["Setup Guide", https://github.com/moode-player/moode/blob/develop/www/setup.txt"], or readme_title: "Setup Guide" readme_url: "https://github.com/moode-player/moode/blob/develop/www/setup.txt"

Displayed as:

Moode Audio player 8.3.7 (64-bit Bullseye) Audiophile music streamer for the Raspberry Pi Released: 2024-12-07 Online: 1.10 GB download Readme: Setup Guide

[tdewey-rpi]

Understood, and accepted. As it's a schema change with UI implications, this might take longer to deliver - and I'm particularly mindful we're approaching the holiday season in the US and UK. That said, I approve of the concept.

[moodeaudio]

Ok cool :-)