A concession on documentation warnings and notes

Đang mở
#55 1 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ó
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ả

documentation

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
Image
Current on MkDocs
Image
Old on GitHub
Image
Old on MkDocs
Image
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

Mở trong Codespaces

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.

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 testcontainers/testcontainers-native

Tất cả issue của testcontainers/testcontainers-native

Issue tương tự

Thêm issue về C

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.