Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Lane 2 · kotlin-core] NotImplemented stubs — Markdown output for the operator docs generator

Đang mở Phù hợp với người mới
#1,418 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
kotlin
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với build-logic/convention/src/main/kotlin/GenerateDocumentationTask.kt và đọc generateAsciidoc để hiểu chỉ mục, các trang toán tử và ma trận độ bao phủ. Triển khai đầu ra Markdown tương ứng, sau đó giảm số lượng trong config/stub-allowlist.txt từ 2 xuống 1 và chạy ./gradlew checkUnmarkedStubs. Hoàn tất khi Markdown hiển thị cùng các hàng như ma trận AsciiDoc và kết quả được báo cáo trong issue cha #1414.

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

Mô tả

coding good first issue size:s skill:kotlin-core sub-issue

Sub-issue of #1414 ([Feature]: Close the remaining NotImplemented stubs outside the operator surface).

Lane: 2 · Kotlin core
Skill needed: Kotlin (Gradle build-logic). No SKaiNET runtime knowledge needed.
Size: s (a few hours)
Blocked by: nothing

What to do

  1. GenerateDocumentationTask (build-logic/convention/src/main/kotlin/GenerateDocumentationTask.kt) throws for DocumentationFormat.MARKDOWN (and HTML).
  2. Implement Markdown by mirroring generateAsciidoc (index, one page per operator, coverage matrix as a Markdown table).
  3. Lower the file's count in config/stub-allowlist.txt from 2 to 1 (HTML stays); run ./gradlew checkUnmarkedStubs and try it with documentation { format.set(DocumentationFormat.MARKDOWN) } locally.

Acceptance

  • Markdown output renders the same rows as the AsciiDoc matrix
  • Result reported back on the parent issue

Notes

If something here turns out to be wrong or much bigger than the size label, comment on this issue or open a specific bug instead of blocking the parent.

Coverage matrix: docs/modules/ROOT/pages/reference/ops-status-matrix.adoc · How lanes work: Issue taxonomy

Ngôn ngữ chính
Kotlin
Star
52
Fork
15
Merge trung bình
1 ngày 10 giờ
Pull request đã merge (30 ngày)
59

Chuẩn bị môi trường

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 SKaiNET-developers/SKaiNET

Tất cả issue của SKaiNET-developers/SKaiNET

Issue tương tự

Thêm issue về Kotlin

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.