joshmarinacci / ElectronIDE

New web based Arduino IDE
BSD 3-Clause "New" or "Revised" License
246 stars 50 forks source link

what documentation to add and how to add it #56

Open wxl opened 9 years ago

wxl commented 9 years ago

the README says one of the wishlist items is:

figure out how to extract documentation from Arduino library source directly (doxygen?)

unfortunately the Arduino libraries are poorly documented, especially in relation to the actual reference. since there's no relationship between the two, clearly they don't use documentation generators (e.g. doxygen). sadly, none of this seems to be under public version control.

so we could pull off the website (oh yay, html parsing), but this kind of begs the question about what documentation we need. i think one of the goals with Electron is not to just be a great IDE, but to be more friendly to the first time Arduino user. think kids. how do we make it easy?? should we just pull the examples? they're easily found in the libraries. lots learn by example (here's an example for EEPROM). but maybe that's not enough. maybe we need both? neither? what about the actual language reference? i beg you to think about this and leave your thoughts here so we can move forward.