wokwi-boards icon indicating copy to clipboard operation
wokwi-boards copied to clipboard

Not an issue / feature request - I would update the guidelines for PR to add custom boards

Open geekgarage opened this issue 1 year ago • 6 comments

I would love to see a specific guideline with these fields that must be added when doing a custom board PR.

Requirements for PR:

  1. Title Name, could be saved as a simple txt file named "title.txt" so it can be read easily by other systems, like auto generated page Example: AITEWIN ROBOT ESP32-C3 SuperMini
  2. Unique name, is the folder name, could be constructed like this: manufacturer_name-board_name-revision_or_model_name Would be: aitewin_robot-esp32_c3-supermini
  3. board.svg
  4. board.json
  5. diagram.png / jpeg / gif / webp (Pinout Overview Image)
  6. purchase.csv (List with "Site Name" and "Link to buy") Example: Aliexpress,https://www.aliexpress.com/item/1005005757810089.html Ebay,https://www.ebay.com/itm/276300462231 Temu,https://www.temu.com/dk/esp32-c3-development-board-esp32-supermini-wifi-wireless-g-601099534456789.html

Feature request: Add the option to add a "diagram.png / jpeg / gif / webp", then add the "?" above the board like some other components have in Wokwi interface and when clicking it, it will show a new page auto generated from the content of the custom board folder so it will show the Title Name as the page title, below that the board.svg, then the diagram.png (or one of the other file types) and then the board.json, and finally a list where to buy, read from the CSV.

This way if a board gets updated on GitHub, the website is automatically updated with the latest info as the PR gets approved. This way you can have more people helping maintaining information without actually doing any work except making sure no sneaky website have been added by a nefarious player before approving PR.

geekgarage avatar Jan 30 '24 12:01 geekgarage