search

RAKWireless / WisBlock

Quickstart, tutorials and examples for the RAKwireless WisBlock product line.
https://www.rakwireless.com
MIT License
158 stars 117 forks source link

Document how to upgrade bootloader if BLE OTA fails #25

Closed jpmeijers closed 3 years ago

jpmeijers commented 3 years ago

In file https://github.com/RAKWireless/WisBlock/blob/master/bootloader/RAK4630/new/README.md

I would like to see the alternative bootloader upgrade steps listed:

https://forum.rakwireless.com/t/bootloader-fails-to-upgrade-via-ble/4193/3

https://forum.rakwireless.com/t/bootloader-fails-to-upgrade-via-ble/4193/4

Currently information on the Wisblock is very spread out in different locations: Forum, docs, readmes. This makes it very difficult for users to know where to go looking if they have a problem. I'd suggest using the README.md files as primary source, building the docs from them. If a question is answered on the forum, that answer should be included in the readmes.

beegee-tokyo commented 3 years ago

@jpmeijers thank you for your feedback.

We are constantly working on improvements of the WisBlock documentation. With more and more modules added to the WisBlock family, documentation will be concentrated in our Documentation Center, where you can already find the updated guides how to update the bootloader of the RAK4631. The WisBlock repository will be the storage for source codes mainly and the forum for discussions about user problems.

jpmeijers commented 3 years ago

I still think it is a bad idea having the source and the documents separated like that. Would be much better having them together.

jpmeijers commented 3 years ago

And my other main issue is that there are multiple versions of documents laying around. How should a user know which one is the latest? Better to consolidate everything so that there is no misunderstanding.

beegee-tokyo commented 3 years ago

Having code and documentation separated in Github and Website is a common practice. As I said before, we are working on it.