CedarCopilot/cedar-OS

fix: make type discoverability better

Offen

#131 geöffnet am 28.08.2025

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (18 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (169 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche die Typedoc Konfiguration für TypeScript Typen und das Äquivalent für Zod Schemata in den Dateien AgentConnectionTypes.ts und AgentInputContextTypes.ts. Sieh dir vorhandene Dokumentationsmuster an und entscheide, wo JSDoc Kommentare oder Zod.describe() Aufrufe platziert werden sollen.
Tech Stack
typescript
Domain
frontenddeveloper experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptZod
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65