docs: restructure README and add harness-eval references - #77
Open
Benkapner wants to merge 1 commit into
Open
Conversation
Moved gates architecture, submission formats, extensibility, and persistence sections into dedicated files under Docs/. README reduced from 691 lines to 139 with links to the detailed documentation.
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.
Summary
The README was 691 lines long, mixing quick-start content with full reference documentation. This PR slims it down to 139 lines and moves the detailed sections into dedicated files under
Docs/.What moved
Docs/gates-architecture.mdDocs/submission-formats.mdDocs/extensibility.mdDocs/persistence.mdCompass Facts Integration was already in
Docs/compass_facts_integration.md.What's new
Added harness-eval references:
Docs/gates-architecture.md: documented both security scanners (Cisco + harness-eval) and both quality sources (LLM review + harness-eval)What stayed in README