docs(readme): refresh for current deliverables and visual appeal - #71
Merged
Merged
Conversation
The README predated most of what the repo now ships. Rewrite it: - Centered header with tagline, badge row (OWASP, live-webapp, DSGAI-21, frameworks-26, scanner v0.3.0, license, PRs-welcome) and a quick-nav line with explicit anchors. - Prominent call-to-action to the Crosswalk webapp, and a feature table with deep links (Score Your Coverage, Explorer, Coverage Matrix, Incidents, Submit a Standard). - Crosswalk stats corrected: 51 entries across 4 source lists x 26 frameworks, 3,800+ mappings, 131 incidents; framework list replaced with the 26 actually mapped (was a stale 21-framework list naming frameworks the crosswalk does not carry). - New DSGAI Scanner section (previously absent): v0.3.0, 107 rules, languages, SARIF/Semgrep/gitleaks, quick start, sample report. - Datasets table with real per-dataset entry counts; datasets that exist are no longer listed as 'proposed'. - At-a-glance deliverables table, repository map, condensed workstreams; every prior section kept (white papers, DSGAI table, collaboration, contribute, initiatives table, acknowledgments, license). All relative paths verified against the tree; all external URLs return 2xx/3xx with a browser UA except the two known bot-blocks (Slack, LinkedIn), unchanged from before. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KJVKF6raJCNKBWjTkDSqR4
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.
The README predated most of what this repo now ships — the crosswalk section said 21 frameworks (it's 26, with 3,803 mappings across 51 entries), the DSGAI Scanner wasn't mentioned at all, and datasets that hold data were still listed as "proposed".
What changed
<a id>anchors (emoji headings make GitHub's auto-slugs unreliable).data/frameworks/in the crosswalk repo); the old list named frameworks the crosswalk doesn't carry (COBIT, BSIMM, FAIR, OPENCRE…).Verification
data/stats.json(v4.0.0) and this repo's dataset folders today.Repo topics were also updated for discoverability (owasp, ai-security, llm-security, data-security, dsgai, risk-taxonomy, prompt-injection, agentic-ai, mitre-atlas, security-datasets, security-scanner).
🤖 Generated with Claude Code
https://claude.ai/code/session_01KJVKF6raJCNKBWjTkDSqR4