Korobi Documentation

Korobi is a cross-network IRC bot aimed at making channel management easier. It has the functionality to log and track statistics for channels, as well as providing a variety of other useful utilities.

This repository includes the official documentation which is available at https://docs.korobi.io and also functions as an issue tracker for the project as a whole. Please don't hesitate to create an issue if you have an idea or you've found an issue with the site, IRC bot or another component of the project.

Local Environment

You can setup an environment to instantly see the changes made to the docs.

1. Install Python 2.7 and Sphinx
2. Install pip
3. Install node.js

In terminal or the command line, within the directory containing this README, run the following commands:

npm install -g gulp
npm install
pip install -r etc/requirements.txt
gulp

Your browser should open to reveal the docs. When you make a change to the documentation, the docs should refresh in the browser (possibly after a few seconds).