Update hardware package's documentation with supported/tested devices #129
Description
A common question raised on the GitHub Discussions forum is whether a particular device is supported or if anyone has experience getting it to work. Having a list in the respective hardware package documentation (once those are set up) or somewhere central would be helpful for:
- Users planning to purchase new hardware and looking for guidance on compatible devices.
- Users troubleshooting issues with their Bonsai workflows who are unsure whether the problem lies in their workflow or the lack of device support.
Some examples of such questions on the GitHub discussions forum:
- https://github.com/orgs/bonsai-rx/discussions/1247
- https://github.com/orgs/bonsai-rx/discussions/2140
There are of course several issues to deal with:
- It is neither feasible nor our responsibility to test every compatible hardware device in all possible configurations.
- A simpler approach—given that we target a specific SDK—would be to reference the hardware manufacturer’s list of supported devices. However, such lists may not be available for all packages. And they might not be guaranteed to work.
One way to approach this would be to list all the devices/device family/generation that should work, but only put a checkmark next to the ones we have personally tested as in this example.