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.
This pull request adds comprehensive documentation for SafeClaw, including a high-level architecture overview and a step-by-step getting started guide. The new docs clarify system components, package boundaries, security model, onboarding flow, and extension points for developers.
Architecture and System Design
docs/architecture.mddetailing the overall system architecture, including a diagram of core components (channel adapters, gateway, session manager, agent, sandbox, vault, audit log, capability registry), their interactions, and the request/data flow.Developer Extension Points
ChannelAdapterinterface and new tools via theToolHandlerinterface, including code examples for both.Getting Started and Onboarding
docs/getting-started.mdwith prerequisites, installation instructions, kernel capability checks, and a detailed five-step onboarding wizard (kernel check, GitHub auth, vault creation, signing key generation, model selection).