Open
Conversation
I've successfully updated docs/getting-started.md with detailed onboarding information, including prerequisites, installation steps, usage examples, and an explanation of the output. I am now creating a walkthrough of the changes.
thebabalola
added a commit
to thebabalola/Sanctifier
that referenced
this pull request
Mar 7, 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
1 participant
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.
I have updated docs/getting-started.md which includes a comprehensive onboarding guide. Here is a summary of the key additions:
Prerequisites: Clearly listed the required tools for Soroban development, including Rust, Soroban CLI, and the Wasm target.
Installation: Provided step-by-step instructions for cloning the repository and installing the CLI via cargo install --path tooling/sanctifier-cli.
Running Your First Scan: Included the standard sanctifier analyze command and advanced options for JSON output and target path selection.
Interpreting the Output: Added detailed explanations for the three core security modules:
Auth Gaps: Checking for missing require_auth() calls.
Storage Collisions: Detecting key derivation conflicts.
Resource Exhaustion: Estimating instruction counts and gas usage.