Menu

#4 Improve (Create!) Documentation

open-accepted
Other (1)
9
2009-05-21
2009-05-20
No

pyGBot has an almost complete lack of documentation, both for developers and users. In order to increase the usability of the project, it must be improved. As it is, there is no documentation to even explain how the bot works or how the plugins can be developed.

Discussion

  • Rob Yurkowski

    Rob Yurkowski - 2009-05-20
    • priority: 5 --> 9
     
  • Morgan L

    Morgan L - 2009-05-21
    • assigned_to: nobody --> robyurkowski
    • status: open --> open-accepted
     
  • Morgan L

    Morgan L - 2009-05-21

    I'm thinking a wiki is probably the best option for this. sf provides one, I'll have a look at what's involved in setting it up.

     
  • Rob Yurkowski

    Rob Yurkowski - 2009-05-21

    A wiki would be helpful, but I think ultimately I would aim to include either html docs or a pdf of our complete documentation. A wiki is generally more helpful for tutorials, which, while important, comes after documenting the use of the bot and the API .

    However, I urge you to continue this line of inquiry.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.