A concession on documentation warnings and notes
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ệ
- github
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start by reviewing the documentation changes in PR #48 and comparing how warnings and notes render on GitHub versus MkDocs. Determine whether the syntax should be changed, supported through a MkDocs plugin, or maintained separately; done means the chosen approach and its rendering behavior are documented and consistent.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
There has been a documentation "regression" from my PR #48. The rendering of warnings and notes look good on GitHub (since they use the GitHub syntax) but do not look good when rendered via MkDocs.
Is this something we need to care about in the long run? I figure most of them will disappear as we author documentation on the relevant pages, and as the project matures.
Alternatively, there might be a MkDocs plugin for parsing the GitHub syntax warnings and notes. There might also be some way to only render GitHub syntax on GitHub, and only MkDocs syntax on MkDocs.
This issue is raised to highlight the change.
How the variants look
Current on GitHub
Current on MkDocs
Old on GitHub
Old on MkDocs
- Ngôn ngữ chính
- C
- Star
- 58
- Fork
- 14
- 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ởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Không có Dockerfile hay tệp Docker Compose
- 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 testcontainers/testcontainers-native
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
testcontainers/testcontainers-native#70 · 1 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
-
documentation help wanted
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
Tất cả issue của testcontainers/testcontainers-native
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
schrodinger/pymol-open-source#532 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 73/100
facebookexperimental/hermit#347 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 86/100
CTSRD-CHERI/cheribsd#2769 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Add unit tests for SafetyStateĐang mởgood first issue not started
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
CU-Robotics/firmware#257 ·
-
valkey-benchmark got `WARNING: Could not fetch server CONFIG` when running against the proxyĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
valkey-io/valkey-proxy#45 ·
Maintainer thường phản hồi trong vòng 1 ngày