SRM Notes for 11-07-2024

[bruno-f-cruz]

Agenda

• 🚀Small Issue (10min)
• 🚅Medium Issue (20min)
• 🐢Large Issue (30min)

New proposals:

• Go over device-specific documentation on the website 🐢
• v3.0 firmware release device.soundcard#20 🐢

Revisit:

[bruno-f-cruz]

Regarding documentation:

• Consider adding "examples" folder to each device repository
• Inside have one folder for each example with a readme and bonsai workflows used in the example.
• At doc generation, the action could look for this folder and generate sections/subsection for each example
• In the harp-tech website:
  1 - Render all examples in the Reference section of each device. Where each entry is a new device
  2 - Split the Bonsai API from the "conceptual" and examples docs by, for each device, creating a new section in the Manual tab. This would be nicer if people are not super concerned with the csharp centric docs and more concerned with the recipes.

All recipes should be scoped to the device. Examples that use multiple devices should be moved to tutorials.