doc: fix stale README config examples and field references#43
Merged
Conversation
Agent-Logs-Url: https://github.com/ParanoiHack/ScopeGuardian/sessions/b2979dfd-db2f-4b9e-9811-dbe7b83dc2fc Co-authored-by: Nitr4x <10544300+Nitr4x@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
Nitr4x
April 30, 2026 14:38
View session
Nitr4x
approved these changes
Apr 30, 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
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.
Description
The README had two stale areas:
pathwas documented as a per-scanner field inside[kics]and[opengrep], but the actualConfigstruct and both scanner factories use a single top-levelpathfield. The proxy example block also omittedssl_cert_file.Changes:
pathout of[kics]and[opengrep]to the top level; removed redundant# Directory to scancomments from scanner sectionsssl_cert_fileline to the commented-out proxy snippet[kics].path/[opengrep].pathrows with a single top-levelpathrow; updated footnote to reflect both scanners share itType of Change
How Has This Been Tested?
Documentation-only change. Verified against
loader/dto.go(Config.Pathtop-level field) and both scanner factories (kics/factory.go,opengrep/factory.go) which consumeconfig.Path.Checklist
go vet ./...passes)go test ./...)Screenshots / Output (if applicable)
N/A