Documentation!
32 views
Skip to first unread message
Graylin Kim
Jan 20, 2012, 2:43:30 AM1/20/12
to sc2r...@googlegroups.com
General consensus was that we need better documentation so here's a quick update.
I've begun work on a better user manual. You can find and monitor the progress in the new_data branch on readthedocs. The old version of the manual can still be found on the latest branch on readthedocs for comparison. I am basically envisioning the manual as a mixture of boring reference pages and short, readable tutorials that can give a really hands on perspective on what working with sc2reader is like.
I spoke briefly with rejuxst and he has more or less taken ownership of the wiki. It has been re-organized to focus on communication, guidelines, and objectives within the developer community. In general, normal users of the sc2reader library will be referred to the User Manual and all corresponding material has been/will be removed from the wiki. It also, is a work in progress.
Please check out the wiki and the user manual and let us know what you think! I'd like to make sure thing are moving in the right direction before we head too far down this road.
~Graylin
I've begun work on a better user manual. You can find and monitor the progress in the new_data branch on readthedocs. The old version of the manual can still be found on the latest branch on readthedocs for comparison. I am basically envisioning the manual as a mixture of boring reference pages and short, readable tutorials that can give a really hands on perspective on what working with sc2reader is like.
I spoke briefly with rejuxst and he has more or less taken ownership of the wiki. It has been re-organized to focus on communication, guidelines, and objectives within the developer community. In general, normal users of the sc2reader library will be referred to the User Manual and all corresponding material has been/will be removed from the wiki. It also, is a work in progress.
Please check out the wiki and the user manual and let us know what you think! I'd like to make sure thing are moving in the right direction before we head too far down this road.
~Graylin
David Joerg
Jan 20, 2012, 2:27:39 PM1/20/12
to sc2r...@googlegroups.com
Great news Graylin! The PrettyPrinter example is very nicely done. --dj
Reply all
Reply to author
Forward
0 new messages