CedarCopilot/cedar-OS

fix: make type discoverability better

Aperta

#131 aperta il 28 ago 2025

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)TypeScript (18 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (169 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la configurazione di Typedoc per i tipi TypeScript e l'equivalente per gli schemi Zod nei file AgentConnectionTypes.ts e AgentInputContextTypes.ts. Osserva i pattern di documentazione esistenti e decidi dove inserire commenti JSDoc o chiamate Zod.describe().
Tech stack
typescript
Dominio
frontenddeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptZod
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65