Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭 适合新手
#1,418 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
kotlin
领域
documentation

调研方向

从 build-logic/convention/src/main/kotlin/GenerateDocumentationTask.kt 开始,阅读 generateAsciidoc 以了解索引、运算符页面和覆盖率矩阵。实现对应的 Markdown 输出,然后将 config/stub-allowlist.txt 中的计数从 2 降至 1,并运行 ./gradlew checkUnmarkedStubs。当 Markdown 呈现的行与 AsciiDoc 矩阵相同,并且结果已在父 issue #1414 中报告时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

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

主要语言
Kotlin
星标
52
派生
15
平均合并
1 天 10 小时
30 天内合并 PR
59

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

SKaiNET-developers/SKaiNET 的其他 Issue

查看 SKaiNET-developers/SKaiNET 的全部 Issue

相似的 Issue

更多 Kotlin Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。