Set up initial documentation
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 20/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- jupyter-notebook, python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách giải quyết ba câu hỏi trong issue: mục đích của repository, tài liệu và các tutorial nên được phân chia như thế nào, và có nên sử dụng MkDocs hay mdBook. Issue không nêu tên file hoặc test nào. Công việc được xem là hoàn tất khi đã thống nhất phạm vi tài liệu, vị trí của các tutorial và tooling cho GitHub Pages.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
At some point, we will probably want the code and notebooks in this repo to have documentation on GitHub Pages.
We will need to work out a few things before we do that, namely:
- What do we want this repo to be for? Are we going to publish a Python package or is it just example Jupyter notebooks etc.?
- How are we going to divide the documentation between this repo and the main one? Where should tutorials live?
- What tooling do we want to use for this? MkDocs is the obvious choice (there is also a plugin for notebooks), but we could also go with mdBook, as we've done for the main repo, for consistency.
My feeling about 2 is that it probably makes sense to have tutorials in this repository, as we will want to walk users through analysing the data, which will be easier if we embed Jupyter notebooks.
- Ngôn ngữ chính
- Python
- Star
- 0
- Fork
- 0
- Merge trung bình
- 17 giờ 5 phút
- Pull request đã merge (30 ngày)
- 11
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
- Đọ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 EnergySystemsModellingLab/muse2_data_analysis
-
Add issue templates/forms Đang mở
EnergySystemsModellingLab/muse2_data_analysis#59 · 1 người được giao ·
Tất cả issue của EnergySystemsModellingLab/muse2_data_analysis
Issue tương tự
-
triage/confirmed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
agentscope-ai/agentscope#2775 ·
-
comp/desktop P3 type/bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
NousResearch/hermes-agent#118866 ·
-
bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
apache/cloudstack#14222 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100