CedarCopilot/cedar-OS

fix: make type discoverability better

Ouverte

#131 ouverte le 28 août 2025

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)TypeScript (18 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (169 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez la configuration Typedoc pour les types TypeScript et l'équivalent pour les schémas Zod dans les fichiers AgentConnectionTypes.ts et AgentInputContextTypes.ts. Regardez les modèles de documentation existants et décidez où placer les commentaires JSDoc ou les appels Zod.describe().
Stack technique
typescript
Domaine
frontenddeveloper experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptZod
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65