[FR] Update Documentation to better explain differences of firmware files

[KoMa1978]

It would be great if the documentation can be enhanced to better explain what is the difference between the files:
*.firmware.bin
*.firmware.factory.bin
littlefs.bin

And when to use which one.
Especially in a OTA upgrade would there be a reason to flash the *.firmware.factory.bin file?
When is it useful/required to flash the littlefs.bin in an OTA?

Thanks a lot

[rednblkx]

Hi there!

This is already documented in Setup and Updates.

I’m open to ideas, let me know how can this be improved.

[rednblkx]

the littlefs.bin is not required to be used every update since changes to the UI don’t occur on every update but I’ll think about adding a note to the release notes.

[KoMa1978]

What I missed (it was the first update I've done) is an explanation which files to use ...

I assumed that the factory-file is for complete flashing so it would be good to write:
*.firmware.bin: The main application firmware file. The *.firmware.factory.bin file is not needed for updates.
The esp32XX-firmware.bin and littlefs.bin files. The esp32XX-firmware.factory.bin is not needed for updates.

For the littlefs.bin it would be great to add the info that no frequent update is needed. In case this file "must be installed" because it contains changes, I assume it will be written in the release notes of the version.

BTW: Your documentation is awesome! If I compare it with other projects, these are only small adjustments ...

[rednblkx]

Appreciate the feedback, I try not to provide too much information so to not overwhelm people but I’ll think about it and try to provide a more clearer explanation.

I’m glad to hear that you like the documentation , the project underwent quite a lot of changes over the years, the current wiki is a new addition, previously used GitHub’s wiki tab, so it’s nice to know it’s helpful.

[KoMa1978]

That would be great! In my case the reader is mounted into a wall and having it reflashed via USB is always a lot of work.
Since it was the first upgrade I did I was unsure how to proceed (which firmware.bin file, do I need to flash the littlefs.bin from 0.7.1 -> 0.8?)

[rbswift]

I just updated to 0.8 and it took me a long time to rediscover the documentation site on github.io.

Maybe something about the "Documentation" link being centred on README.md threw me off and made it look more like a title. I wasn't really looking for an external link because I thought all the information would be in the README.md file or another .md file in the repo.

I'd suggest a section on README.md titled "Documentation" with text like ... This README.md page provides a summary of the project. For the full detailed documentation head over to: https://rednblkx.github.io/HomeKey-ESP32/

Maybe also insert an "Updating" subheading below "Installation Steps" with text like ... Update instructions can be found in the documentation at: https://rednblkx.github.io/HomeKey-ESP32/updates/