Supybot Website

You are here: Home » Documentation » Documentation we need, but don't have.

Documentation we need, but don't have.

Here's a list of the documents we need, but don't currently have. If you're in a documenting mood, this is a good place to find stuff to document.

The INSTALL document needs to be converted to a howto. (Done: here)
A plugin-writing tutorial. We have PLUGIN-EXAMPLE in our 0.80.1 release, but it needs to be updated to use commands.wrap as well as converted to STX. (Done: here)
A "Using Services" howto. If I had a nickel for every time someone asked us how to make the bot identify... (Done: here)
Some glossary entries describing common Supybot terms like "nested commands" and "capabilities". (Done: here)
Some error references describing some common errors. In particular, we need to describe these errors:
- "An error has occurred and was logged..." -- Users need to know what to do when that happens.
- Not identified
We should have a document for user's users, that is, for people who aren't running the bot, but who are using a Supybot that somehow magically joined their channel. Perhaps a link to this can be thrown into the help for Misc.help.
An equivalent of our "DEVS" document.
We could use some more pages in the "Hacking Supybot" tutorial.
An equivalent of our "ACKS" document.