docs(readme): rewrite for v0.3 accuracy + professional visual layout - #54
Merged
Conversation
…isual layout Bring the README in line with the shipped v0.3 engine and give it a top-tier, GitHub-native presentation. Accuracy fixes (stale v0.2 claims removed): - CVE sources are OSV + NVD only (drop AVID / GitHub Advisory) - reports are timestamped under dsgai-reports/ (not DSGAI-report.html at root) - redaction is the V1-V3 rg -o --replace '' protocol with file IDs (not V1-V6) - GitHub Action is the two-job, secret-less, SARIF-native workflow (no ANTHROPIC_API_KEY) - document SARIF/Code Scanning, 5 CLI subcommands, 6 CVE ecosystems, gitleaks + Semgrep packs, suppressions/baseline/--diff, C#/Rust/Ruby Presentation: - centered masthead (title, tagline, badges, nav), TOC, feature grid - redrawn mermaid showing the deterministic core vs optional LLM layer - collapsible reference (controls, checkpoint, PDF, scope, tiers) - GitHub alerts, a 'Why this scanner' positioning section - OWASP + Emmanuel Guilherme Junior / Harish Ramachandran attribution preserved Verified: internal links resolve, no-overclaim gate clean, all referenced paths exist, suppression/CLI facts checked against the code.
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.
What
Rewrites
dsgai_scanner_tool/README.mdto match the shipped v0.3 engine and give it a top-tier, GitHub-native presentation. Docs-only — no code, rules, or workflow changes.Why
The README had drifted to v0.2 and made claims the current code contradicts — a poor look for a tool whose brand is deterministic and honest.
Accuracy fixes
DSGAI-report.htmlat repo rootdsgai-reports/DSGAI-report-<ts>.htmlrg -o --replace ''+ file IDsANTHROPIC_API_KEY, fails on FAILDSGAI_FAIL_ONgating--diff, C#/Rust/RubyPresentation
Verification
scripts/check_md_links.py)