Writing documentation

Mudlet’s documentation always could use some love, so all help is appreciated.

Mudlet uses Gobby for editing the documentation. If you haven’t already done so, here are the instructions for setting it up on your computer.

How the process is setup

While the main documentation that’ll eventually go into Mudlet is stored in Gobby, there is also an alternative page that explains the Lua API and some Mudlet basics. It is available here, or an always up-to-date version is available with Mudlet svn sources (mudlet_documentation.html). Heiko updates this documentation as he adds features to the Lua API.

Mudlet’s help files will constist of two ‘chapters’ - one explaining how to use features available in Mudlet and the client itself - intended for novice users, and another focusing in the API - intended for scripters.

To write the explanation section, simply see how Mudlet currently works and write that down. Try to supplement your words with good examples so that people can see a meaningful use for the feature.

For the Lua API section - simply copy over the description from Heiko’s page, re-phase them to be easily understandable, and supplment with examples.

Previewing changes

The server generates the html version of the documentation every few seconds, so you can preview your changes: http://mudlet.org/documentation/mudlet-asciidoc.html

If you’ll require any assistance, feel free to chat with us in IRC.