Repository navigation
docs(tools): document public API - #1814
Closed
EmersonBraun wants to merge 1 commit into
Closed
EmersonBraun wants to merge 1 commit into
EmersonBraun wants to merge 1 commit into
Conversation
Member
Author
|
Superseded by #1818 (DOC-03 batch 5 in one PR). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
@agentskit/tools, including callable parameters, results, errors, and examples for the primary tool factories.Why
Consumers can understand the root package’s built-in tool factories and configuration types from generated declarations.
How
Validation
pnpm --filter @agentskit/tools lint,test(353 passed), andbuildpnpm 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 sizepassed (@agentskit/toolsroot export 9.25 kB gzip under 10.5 kB)