DeployBoard / DeployBoard/deployboard-python

Update Docs

Đang mở
#74 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation enhancement
Ngôn ngữ chính
Python
Star
10
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

**Is your feature request related to a problem? Please describe.**
Lots of pages on the docs are just empty placeholders and is not very helpful.

**Describe the solution you'd like**
We need to update the docs to provide more information. I'm not sure at this time what the "minimum" would be for v1.0.0, but it needs to be enough for a new user to be able to launch the application and start using without questions.

**Describe alternatives you've considered**
None

**Additional context**
None

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

Hướng nghiên cứu

The issue names no documentation files, tests, or entry points; start by inventorying the empty placeholder pages and reviewing how a new user launches the application. Define the minimum v1.0.0 guidance before editing, and consider the work done when a new user can launch and begin using the application without unanswered basic questions.

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

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
20/100

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.