Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No description of the configuration #81

Open
davidyell opened this issue Jun 5, 2018 · 2 comments
Open

No description of the configuration #81

davidyell opened this issue Jun 5, 2018 · 2 comments

Comments

@davidyell
Copy link

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
Copy link
Collaborator

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

@davidyell
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants