Skip to content

docs(tools): document public API - #1814

Closed
EmersonBraun wants to merge 1 commit into
mainfrom
codex/doc03-tools
Closed

EmersonBraun wants to merge 1 commit into
mainfrom
codex/doc03-tools

Conversation

@EmersonBraun

Copy link
Copy Markdown
Member

What

  • Add JSDoc for the 14 undocumented root exports of @agentskit/tools, including callable parameters, results, errors, and examples for the primary tool factories.
  • Reduce the tools baseline from 96 to 82 undocumented symbols; the 82 subpath symbols are reserved for the second tools PR.

Why

Consumers can understand the root package’s built-in tool factories and configuration types from generated declarations.

How

  • Documented the root APIs from their implementations without changing runtime code or signatures.
  • Added a patch changeset: “Document the public API.”

Validation

  • pnpm --filter @agentskit/tools lint, test (353 passed), and build
  • pnpm check:jsdoc-coverage (root undocumented symbols: 14 → 0; total documented: 167/249)
  • pnpm check:public-api-snapshot (24 packages, 74 subpaths, 1,955 symbols; unchanged)
  • pnpm size passed (@agentskit/tools root export 9.25 kB gzip under 10.5 kB)
  • Configured pre-push gates passed.

@EmersonBraun

Copy link
Copy Markdown
Member Author

Superseded by #1818 (DOC-03 batch 5 in one PR).

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