CedarCopilot/cedar-OS

fix: make type discoverability better

Aberta

#131 aberto em 28 de ago. de 2025

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)TypeScript (18 forks)auto 404
documentationenhancementgood first issue

Métricas do repositório

Stars
 (169 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Investigue a configuração do Typedoc para tipos TypeScript e o equivalente para esquemas Zod nos arquivos AgentConnectionTypes.ts e AgentInputContextTypes.ts. Veja os padrões de documentação existentes e decida onde colocar comentários JSDoc ou chamadas Zod.describe().
Pilha de tecnologia
typescript
Domain
frontenddeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptZod
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65