"How to flash the OS image" links the user to this repo's README which provides inadequate documentation
Problem
The documentation page on https://mntre.com contains a link called "How to flash the OS image" that links to the README in this repository. The README briefly describes how to use the scripts to build the images. However, the system and restore images are already made available to the user as build artifacts, and these official system images are already directly linked in the documentation page linked above.
The README says "an image file that can then be transferred to a SD Card using dd
" but does not provide clear guidance how to do so, which was the purpose of the link shown above.
Proposed solution
To resolve this issue, a non-technical user should be able to:
- follow a link on the documentation page listed above
- I would recommend renaming the link "
How to flash the OS image" -> "Writing a system image to internal storage or SD card" as it is more direct with less jargon - If this repository is not suitable for this high-level documentation, they could be redirected to an appropriate section of the user handbook
- I would recommend renaming the link "
- understand the recommended environment for the task (using a host computer to write the SD card image, presumably)
- understand recommended command syntax (perhaps include a disclaimer for data loss, but hold their hand a little)
- understand what to do if something went wrong, or what they should see upon success