As many of you may know by now I am working on a general swerve library (YAGSL). I have been keeping in what I consider to be good development practices for the most part (sorry no unit tests). Every class, attribute, method, and package are documented with a short description of what they do and the javadoc site is public and updated nightly alongside everything else. I also maintain a updated reference guide as a github wiki. We made a simple configurator too for those who are overwhelmed by the options. Ontop of all of this we have functional example code (albeit designed to test swerve drive and not control it during matches) available too.
I know all of this isn’t enough and realize I need to make more robust indepth “here’s how to use this in a program and what you can do” guide. My problem is deciding on a medium, how to start, what should be inside of it, what should I expect the user to know about swerve drives, etc. I would rather not do a video because I am not that good at editing or writing scripts. I love how some teams are not detered by the abysmal state of user documentation but my goal with YAGSL is to make swerve plug and play for the most part, maybe even have a repository of known working configurations for most COTS swerve drives.
I am thinking of starting a readthedocs.io with all feedback and resources necessary to use YAGSL and probably learn about swerve drives.
For those of you who are considering using or already using YAGSL I would love to know what you need to learn first or wish you had learned and what format!