docs(phase-2): add explanation pages (architecture, game-state, runtime)
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- 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
- Ít trao đổi
- Công nghệ
- lua
- Lĩnh vực
- documentation
Hướng nghiên cứu
Rà soát các bản nháp của architecture.md, game-state.md và runtime.md đối chiếu với src/lua/core/, utils/gamestate.lua, platforms/ và các ADRs 0001–0003. Xác nhận rằng mỗi trang có tiêu đề “About X”, trả lời một câu hỏi, sử dụng các ví dụ cụ thể, trích dẫn các đường dẫn mã và liên kết chéo thay vì sao chép các trang tham chiếu của Phase 1. Được coi là hoàn tất khi cả ba trang đều đã được maintainer review; hãy kiểm tra #226 trước vì issue này phụ thuộc vào nó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Part of #224 — v2 docs rewrite (Diátaxis).
Goal
Explanation pages: architecture.md, game-state.md (omniscience/fair-play), runtime.md (platforms + rendering) — each 1.5–3k words, code-cited, titled "About X".
Tasks
- Read
src/lua/core/*,utils/gamestate.lua,platforms/*, ADRs 0001–0003; write with maintainer review - Cross-link to reference pages (never duplicate facts)
- One question per page; concrete examples
Dependencies
- Blocked by: #226 (Phase 1 — reference rewrite)
- Blocks: Phase 3 (how-to), Phase 5 (ship)
Done when
- 3 pages reviewed by a maintainer
- Code paths cited with GitHub links
- Ngôn ngữ chính
- Python
- Star
- 80
- Fork
- 23
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của coder/balatrobot
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
coder/balatrobot#244 ·
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
coder/balatrobot#243 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
coder/balatrobot#235 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
coder/balatrobot#234 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
coder/balatrobot#233 ·
Tất cả issue của coder/balatrobot
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
pylint-dev/pylint#11791 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Rasterio granule reads never retry, so one 503 (Service Unavailable) fails the whole requestCó thể đã có người làm @chuckwondo đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
developmentseed/titiler-cmr#305 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
community enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
Maintainer thường phản hồi trong vòng 1 ngày