Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

No description of the configuration

Đang mở
  • Có gì không ổn?
#81 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với phần “Basic Usage without BotMan Studio” trong tài liệu cài đặt và trang cài đặt driver HipChat. So sánh các ví dụ $config của chúng với cách truy cập cấu hình trong HipChatDriver.php được liên kết và cách xử lý $config trong BotMan.php. Được xem là hoàn tất khi tài liệu giải thích cấu trúc dự kiến và các key riêng của driver, bao gồm một ví dụ cấu hình HipChat có thể sử dụng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
33
Fork
49
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của botman/docs

Tất cả issue của botman/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.