Skip to content

docs: document remaining public APIs (DOC-03 batch 4) - #1816

Merged
EmersonBraun merged 52 commits into
mainfrom
codex/doc03-batch4
Oct 3, 2026
Merged

EmersonBraun merged 52 commits into
mainfrom
codex/doc03-batch4

Conversation

@EmersonBraun

Copy link
Copy Markdown
Member

What

  • Added public API JSDoc for @agentskit/integrations, @agentskit/memory, and @agentskit/observability, including the integrations testing subpath and observability Langfuse subpath.
  • Shrunk the JSDoc coverage baseline after rebuilding declarations.

Why

Make the package contracts discoverable in editor tooltips and generated declarations without changing public signatures.

How

Added concise summaries, callable tags, and examples to the exported declarations, plus patch changesets for each public package. The existing nested ternary in the touched topology graph was rewritten as behavior-equivalent if/else to satisfy the repository gate; the observability suite passes.

Validation

  • Package lint, tests, and builds passed: integrations (157 tests), memory (241), observability (349), and observability Langfuse (38).
  • pnpm exec turbo run build --force passed (44 tasks).
  • JSDoc coverage is 100% for the four DOC-03 packages in scope: integrations 116/116, memory 112/112, observability 141/141, and RAG 59/59.
  • pnpm check:public-api-snapshot passed: 24 packages, 74 subpaths, 1,955 symbols unchanged.
  • pnpm size passed; all configured bundle limits are within budget.
  • The push quality gates passed.

This PR is stacked on #1813 and targets codex/doc03-combined while that PR remains open.

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…03-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…codex/doc03-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…x/doc03-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…/doc03-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…3-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…o codex/doc03-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…doc03-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
…3-combined

# Conflicts:
#	docs/stability/jsdoc-coverage-v1.json
@EmersonBraun
EmersonBraun merged commit b3021da into main Oct 3, 2026
15 checks passed
@EmersonBraun
EmersonBraun deleted the codex/doc03-batch4 branch October 3, 2026 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant