LED-bot icon indicating copy to clipboard operation
LED-bot copied to clipboard
verified publisher icon marqsm

write documentation

Open danasf opened this issue 11 years ago • 3 comments

document the hardware and software build process so it can be reproduced

danasf avatar Aug 26 '14 02:08 danasf

Still a work in progress, but we've added some annotations in the code, docs are on the wiki!

danasf avatar Aug 27 '14 22:08 danasf

It may be nice to have docs inside the repository in rst/markdown.

  • New features or bug fixes can come with documentation fixes.
  • Doc changes will fall nicely into the pull request workflow, and notify everyone of changes.
  • The wiki is not associated with any branch of code, so changes to the documentation will have to wait until the code is on master.

But, also its nice to have it in a wiki, making it extremely easy to view and edit.

punchagan avatar Sep 06 '14 17:09 punchagan

Seems reasonable!

danasf avatar Sep 06 '14 17:09 danasf