Real Admin Documentation

[Einarin]

The bot has a bunch of features that could really use some documentation. Topics include:

Configuring

• auth.json
• config.json
• permissions.json
• rss.json

How the Bot Uses

• alias.json
• messagebox.json

[Einarin]

@chalda Should we use the wiki for documentation, or do you want to do something fancier?

[chalda]

@Einarin as someone says at work. Wikis is where documentation goes to die. I think readme would be fine. Unfortunately JSON doesn't allow for inline comments but nothing prevents us from having the config files be something other then json (would need a special loader for node but thats about it). I really really want to make generating an actual auth.json be part of an installer. This would prevent a lot of errors like missing commas or ". I promise I will get to this one day.

[Einarin]

One thing I saw another bot does that was a great idea is that the first time you start it it asks you questions for each of the things it needs, and then writes the auth file itself.

[F9Alejandro]

using an sqlite file or something like sqlalchemy would greatly benefit the bot to keep everything in a place where it is meant to be accessed numerous times.