docs: consolidate SDK documentation and fix README#47
Merged
Conversation
- Create comprehensive sdk-usage-guide.md with Getting Started, Config Reference, List Skills, Raw Notification, and Low-level APIs sections - Delete 8 redundant example docs superseded by sdk-usage-guide.md - Delete typescript-sdk-reference.md after merging unique content - Fix README: DroidMessageType.TurnComplete → Result, update message type table to match actual enum values Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
varin-nair-factory
force-pushed
the
vn/docs-cleanup
branch
from
4a284ae to
c4603cc
Compare
factory-davidgu
approved these changes
May 22, 2026
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.
Summary
Consolidates SDK documentation into a single comprehensive usage guide and fixes stale references in the README.
Stacked on #46 (
vn/code-quality-cleanup)Changes
New:
docs/sdk-usage-guide.mdComprehensive SDK usage guide covering 26+ use cases with code snippets:
CreateSessionOptions,MessageOptions, Error Types)ProcessTransport,ProtocolEngine,DroidClient)Deleted: 9 redundant doc files
All content superseded by
sdk-usage-guide.md:docs/examples/run.md,session-stream.md,multi-turn-session.md,permission-handler.md,spec-mode.md,init-metadata.md,tool-controls.md,list-sessions.mddocs/typescript-sdk-reference.md(unique content merged into usage guide)Fixed:
README.mdDroidMessageType.TurnComplete→DroidMessageType.ResultDroidMessageTypeenum values:tool_use,turn_complete,create_messageassistant,user,tool_call,tool_call_delta,hook,result,assistant_text_complete,thinking_text_completeValidation
npm run typecheck— passesnpm run lint— passesnpm run format:check— passesnpm test— 646 tests pass