docs: add comprehensive JSDoc and Mintlify documentation#11
Merged
Conversation
Owner
activadee
commented
Dec 31, 2025
activadee
commented
- Add JSDoc comments to all core classes (Droid, Thread, TurnResult)
- Add JSDoc to error classes with examples and category tags
- Add JSDoc to type definitions (config, options, events, turn)
- Add JSDoc to CLI functions (process, installer, stream-parser, utils)
- Add JSDoc to utility functions (models, zod-adapter, events)
- Set up Mintlify documentation with mint.json configuration
- Create documentation pages for concepts, guides, and API reference
- Add TypeDoc configuration for generating API docs from JSDoc
- Add docs generation scripts to package.json
- Add JSDoc comments to all core classes (Droid, Thread, TurnResult) - Add JSDoc to error classes with examples and category tags - Add JSDoc to type definitions (config, options, events, turn) - Add JSDoc to CLI functions (process, installer, stream-parser, utils) - Add JSDoc to utility functions (models, zod-adapter, events) - Set up Mintlify documentation with mint.json configuration - Create documentation pages for concepts, guides, and API reference - Add TypeDoc configuration for generating API docs from JSDoc - Add docs generation scripts to package.json
- Change TypeDoc output to docs/api-generated/ - Keep manual docs in docs/api-reference/ (not overwritten) - Add docs/api-generated/ to .gitignore (regenerate from source)
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.