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