Add comprehensive API documentation generator#351
Merged
Kingsman-99 merged 1 commit intoJun 27, 2026
Conversation
- Add scripts/generate-docs.ts using TypeScript compiler API - Parse src/index.ts and extract exported declarations with JSDoc - Extract @param, @returns, @example tags from JSDoc comments - Render parameter tables and code examples in Markdown - Generate docs/API.md with all 156 exports documented - Add 'npm run docs' script to package.json - Include ts-node as dev dependency for script execution
|
@wendypetersondev Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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.
Closes #144
Implements issue #144: Build SDK comprehensive documentation generator.
Adds a new TypeScript script that automatically generates complete API documentation from JSDoc comments in the SDK source code.
Changes
scripts/generate-docs.ts: New documentation generator script using TypeScript compiler API
docs/API.md: Auto-generated API reference
package.json: Added npm run docs script and ts-node dev dependency
Verification
✓ All 47 existing tests pass
✓ TypeScript strict mode (zero any types)
✓ npm run docs generates docs/API.md successfully
✓ All 156 exports documented with signatures and descriptions
✓ JSDoc tags properly rendered as Markdown tables and code blocks
Technical Details
How to Use
This will generate/update docs/API.md with current API documentation.