CedarCopilot/cedar-OS

fix: make type discoverability better

Open

#131 opened on Aug 28, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)TypeScript (18 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (169 stars)
PR merge metrics
 (No merged PRs in 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.

Contributor guide

Research direction
Investigate Typedoc configuration for TypeScript types and equivalent for Zod schemas in the files AgentConnectionTypes.ts and AgentInputContextTypes.ts. Look at existing documentation patterns and decide where to place JSDoc comments or Zod.describe() calls.
Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptZod
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65