improve documentation

Open aspiers opened this issue 7 years ago • 3 comments

In #39 @waldyrious made a bunch of excellent suggestions about how to improve the documentation. This issue is for tracking the associated work.

Feb 10 '18 23:02 aspiers

Glad you liked the suggestions :) I think it would help, first of all, to know your thoughts about the first two points in this comment, and about this comment as well.

Feb 13 '18 21:02 waldyrious

I agree 100% with everything you wrote, including those three points :-) I don't think I have any additional thoughts to add to them off the top of my head.

Feb 14 '18 00:02 aspiers

Cool, thanks. I'm a bit swamped at the moment so I don't know when I'll get the chance to tackle this, but I think there's now enough concrete actions that someone else can jump in if there's interest :)

Feb 14 '18 08:02 waldyrious