Repository navigation
docs(readme): show what owasp-kb serves and how an agent uses it - #91
Merged
Merged
Conversation
Lead the README with badges, a screenshot of illustrative agent sessions that cite real ids from the index, a table of the five packs with measured counts, example prompts, and the clients it works with. Describe AISVS alongside ASVS and MASVS, and correct the agent count to six. Closes #90
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.
What was wrong
The README opened with a one-line summary and a disclaimer, then went straight into the rationale. A reader could not see what an agent does with
owasp-kb, which standards it serves, or how large they are, without reading every section. It did not mention AISVS. Its install line said the plugin installs five agents;plugins/owasp-kb/agents/holds six.What changed
docs/assets/showcase/index.html.scripts/pinned_tag.py.This branch stacks on the AISVS pack branch, because it documents that pack.
Why this way
The sessions are invented, because the real ones on disk name client projects. Their shape comes from real
owasp-secure-codingannouncements, and every requirement, cheat sheet and CWE id in the image was retrieved from the index. Both the image caption and the page footer say so.Evidence
Counts in What it serves come from a build of the pinned sources on 2026-11-05:
pytestpasses:1162 passed.What is left
The Two variants section still quotes a mean rank of 3.2 lexical and 2.2 hybrid. The quality gate on the AISVS build measured 4.2 and 1.8. That paragraph records measurement history, so it is left for whoever owns the figure.
Closes #90