Thanks Tom. What you have in place has been a good starting point. I would have likely been lost without it.
I wasn’t thinking any specific files yet. I haven’t looked that closely. I was figuring I’d write out some stuff about things I haven’t found documentation on yet. For example, the driver section doesn’t mention anything about SPI yet and this Split function I’m trying to figure out seems like a good thing to put together some examples and explanations for. I expect as I dig in I’ll find other places.
If you have a list of needs, I’d be glad to see what I might be able to take a stab at.
Josiah
···
On Thu, Oct 25, 2018 at 9:12 AM Tom Swirly tom@swirly.com wrote:
The canonical URL is here: https://maniacallabs.github.io/BiblioPixel
I corrected the Wiki to point to the new docs. I didn’t even know about the Cosmo one, but that’s old-old.
We’d love love love love pull requests for documentation!
I actually have considerable further work on documentation in another branch but I got distracted by paying work! - it’s a restructuring of mainly the tutorial part.
Which files were you thinking of changing?
If you wanted to write new documents, that’d be particularly helpful and easy to integrate.
You could make a pull request against dev (not master!) and I could integrate it into the new changes.
I am hoping to get the restructuring out in the next day or two, as well…
On Wed, Oct 24, 2018 at 11:31 PM Josiah Ritchie josiah.ritchie@gmail.com wrote:
So, I’d like to contribute a bit to documentation.
As I’ve been trying to figure out how this all works I see that there is documentation in a few different places where documentation is being provided and with the BiblioPixel 2 to 3 conversion, some of them are for the older and some for the newer. I found these places have some docs, but I’m not sure which is the best place to use.
https://maniacallabs.github.io/BiblioPixel/index.html
https://github.com/ManiacalLabs/BiblioPixel/wiki
https://bibliopixel-mynameiscosmo.readthedocs.io/en/docs/drivers/spi/
Where would it be best to submit stuff?
Just submit PRs to https://github.com/ManiacalLabs/BiblioPixel/tree/master/doc in restructured text?
Thanks,
Josiah
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-labs-users@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/a8081322-fa58-4ae8-9994-540fecee7723%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
–
/t
https://tom.ritchford.com
https://tom.swirly.com
