No description of the configuration
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- php
調査の方向性
インストールドキュメントの「Basic Usage without BotMan Studio」セクションと、HipChat driver のインストールページから始めてください。それらの $config の例を、リンクされている HipChatDriver.php での設定へのアクセスと、BotMan.php での $config の処理と比較してください。ドキュメントで想定される構造と driver 固有のキーが説明され、使用可能な HipChat 設定例が含まれていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- 言語のデータがありません
- スター
- 33
- フォーク
- 49
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
botman/docs のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 55/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 20/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
untriaged
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
dotnet/dotnet-api-docs#13095 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100