search

CaitlynMainer / pircbotx

Automatically exported from code.google.com/p/pircbotx
0 stars 0 forks source link

Create, Update, and Expand Documentation #2

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
Currently there is very little documentation, and the documentation that exists 
isn't very good quality. 

Step 1) Write more documentation. Possible topics:
 - List of major changes from PircBot
 - Quickstart Guide (a bit more in depth than HowTo page)
 - Full (working!) bot example
 - List of example hooks
 - Diagram of internal flow - Eg the path of an event through the parsing layers, the path of sending a message, etc. Really helpful for people wishing to modify code
 - Package structure

Step 2) Keep documentation up to date. This includes changes in code and 
grammar fixes

Any help is appreciated, especially reviewing existing documentation.

Original issue reported on code.google.com by Lord.Qua...@gmail.com on 24 Feb 2011 at 11:04

GoogleCodeExporter commented 9 years ago 
Personally, I think you should have a download link for the Javadoc.

Original comment by netgooguy@googlemail.com on 17 Jul 2011 at 6:10

GoogleCodeExporter commented 9 years ago 
Would it matter that the javadoc is in JAR format? Maven automatically builds 
that for me so I would like to use it.

Beta 2 Javadoc is available here: 
http://repo1.maven.org/maven2/org/pircbotx/pircbotx/1.3-Beta-2/pircbotx-1.3-Beta
-2-javadoc.jar

Dev Javadoc is available here: 
http://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=org.
pircbotx&a=pircbotx&v=1.3-SNAPSHOT&e=jar&c=javadoc

Original comment by Lord.Qua...@gmail.com on 18 Jul 2011 at 3:43

GoogleCodeExporter commented 9 years ago

Original comment by Lord.Qua...@gmail.com on 24 Nov 2014 at 3:17