search

botman / docs

BotMan documentation
33 stars 52 forks source link

No description of the configuration #81

Open davidyell opened 6 years ago

davidyell commented 6 years ago

The documentation seems to lack any description of what the $config variable should contain.

The installation docs under 'Basic Usage without BotMan Studio' stipulate a $config variable, and define it as an array, but not any of the keys.

$config = [
    // Your driver-specific configuration
    // "telegram" => [
    //    "token" => "TOKEN"
    // ]
];

The 'driver-specific configuration' seems to suggest this would be in the driver. However all I could find was the root array key for the driver, but not what any of the configuration key values were.

The BotMan class which takes the $config variable does not type hint $config as an array, so I'm not sure if it has to be an array or not.

My specific use-case is that I'm trying to configure Hipchat, and the documentation for this driver does not detail any of the configuration required.

So I feel at a bit of a dead-end here. This leads me to think there could be some improvements to the documentation made, for those of us who are not using BotMan Studio, or paying for the video course.

christophrumpel commented 5 years ago

Sry for the late reply. You are right the docs are missing some info here. A PR would be a lot of help.

davidyell commented 5 years ago

Sorry, but I won't be able to provide a pull request. As Hipchat will be closing in Feb 2019, we've already moved over to Slack, so don't have a requirement for Botman any more.