Repository navigation
docs: add public JSDoc to tools, skills, mcp and cross-platform (DOC-03) - #1818
Merged
Merged
Conversation
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
Documents the public API of
@agentskit/tools,@agentskit/skills,@agentskit/mcpand@agentskit/cross-platform(one commit per package) and regenerates the JSDoc coverage baseline once. Supersedes #1814.Why
DOC-03: public exports need JSDoc.
How
skillswere flattened with equivalent code:compose.tsnames the activate hook (activateAll),translator.tsmoves the glossary IIFE intorenderGlossaryData(same output string).toolssymbols re-exported frompackages/integrations(documented at the origin by docs: document remaining public APIs (DOC-03 batch 4) #1816) and 6cross-platformpath aliases from the externalpathepackage.Validation
pnpm buildok; package lint ok;@agentskit/skillstests 444/444node scripts/check-jsdoc-coverage.mjsok — 1673/1954 (85.6%); baseline: 141 entries removed, 0 addednode scripts/check-public-api-snapshot.mjsok;size-limitok; nested-ternary gate ok