Dana-Ferguson
Improve documentation
I have a hard time understanding this library and can't afford to spend hours digging in the unit tests for examples. My request is to have better documentation in place.
Perhaps Documentation Driven Development helps in this?
I want to improve the documentation. But, I also want to stabilize the public API (which seems more important according to agile value 2), and a ton of other things. I anticipate this journey taking easily the rest of the year. (corollary: when I'm on vacation from work, I'm also on vacation from here too -- hence: no commits last week)
I am one person with several competing interests, and I'm doing this to
- Fill a niche needed in the Dart ecosystem.
- Have fun.
At most, I can only work on this project about an hour a day. : - (
Best I can answer, if you have questions, open an issue. The other thing that seems to be becoming popular is to create a discord channel -- since they're
- Very flexible
- History doesn't get deleted and is searchable (this one is huge)
- Free
- Can feel more friendly
My dream for the documentation is to have it be interactive (since we can compile to web as well as mobile, no reason we can't have lots of searchable examples online). I also think, the more graphical and play/exploration-based we can make the documentation, the more we can get away from it being hard for non-native english speakers.
