CedarCopilot/cedar-OS

fix: make type discoverability better

開放

#131 建立於 2025年8月28日

在 GitHub 查看貢獻者指南
 (1 則留言) (0 個反應) (0 位負責人)TypeScript (18 個分叉)auto 404
documentationenhancementgood first issue

倉庫指標

星標
 (169 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

For types exposed to the user (mainly in AgentConnectionTypes.ts and AgentInputContextTypes.ts, we need to make the discoverability of the types better, especially if they take in generic parameters.

Probably would use Typedocs for Typescript types, and an equivalent for Zod types.

貢獻者指南

研究方向
檢查 TypeScript 類型的 Typedoc 配置以及檔案 AgentConnectionTypes.ts 和 AgentInputContextTypes.ts 中 Zod 模式的等效配置。查看現有的文件模式，並決定在哪裡放置 JSDoc 註釋或 Zod.describe() 調用。
技術棧
typescript
領域
frontenddeveloper experience
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
TypeScriptZod
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65