📚 Documentation: App class documentation is not up to date

Đang mở
#91 0 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
48/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

Compare README.md and Getting-Starting-Guide.md with the current App class behavior, focusing on the documented hook types and init parameters. Update both documents so they describe the current API accurately, then verify that the outdated three-hook and parameter descriptions are gone.

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

Mô tả

💭 Description

Both the README.md file and the Getting-Starting-Guide.md file suggests that there are 3 types of hooks, and that the parameters for the init hook for example are a callback function, a resources array, and a group.

However, this has not been the case for the past 2 years.

Documentation should be updated.

👀 Have you spent some time to check if this issue has been raised before?
  • I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
Ngôn ngữ chính
PHP
Star
297
Fork
34
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 utopia-php/http

Tất cả issue của utopia-php/http

Issue tương tự

Thêm issue về PHP

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.