docs: positioning, runnable examples, coverage matrices, and tutorial#31
Merged
Conversation
Closes the visible-contribution-surface gap that the empty issue tracker and the absence of examples/coverage docs created — companion to the contributor issues filed in #17–#30. README: - New tagline: "AI compliance rules you can read, run, diff, and prove." - GOPAL acronym + "open policy pack for AI regulation" framing on the first line of the description. - New sections: AI-compliance-rules H2 (5-bullet positioning), Why now, For OPA / Rego users, GOPAL vs AICertify, Try GOPAL in 30 seconds, Policy correctness disclaimer. examples/: - Four runnable demos with input.json + run.sh + expected-output.json + README, each verified to produce the documented verdict via opa eval: eu-ai-act-transparency, nist-ai-rmf-govern, customer-support-llm, education-proctoring. docs/coverage/: - Per-framework matrices for the EU AI Act and NIST AI RMF marking each obligation Implemented / Scaffold / Planned with file paths. docs/tutorials/add-your-first-policy.md: - End-to-end policy authoring walkthrough; the embedded example was verified to pass opa check and 5/5 opa test cases locally before shipping. docs/INDEX.md: - Links the new tutorials, examples, and coverage matrices.
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.
Summary
Closes the visible-contribution-surface gap that the empty issue tracker and the absence of examples/coverage docs created. Companion to the contributor issues filed at #17–#30.
README
examples/Four runnable demos with
input.json+run.sh+expected-output.json+README, each verified to produce the documented verdict viaopa eval:eu-ai-act-transparency/nist-ai-rmf-govern/customer-support-llm/education-proctoring/docs/coverage/Per-framework matrices for the EU AI Act and NIST AI RMF marking each obligation Implemented / Scaffold / Planned with file paths. Aviation, education, and BFS coverage matrices filed as contributor issues (#24, #29, #30).
docs/tutorials/add-your-first-policy.mdEnd-to-end policy authoring walkthrough. The embedded example was verified to pass
opa checkand 5/5opa testcases locally before shipping.docs/INDEX.mdLinks the new tutorials, examples, and coverage matrices.
Test plan
opa check --ignore custom/ .— cleanopa test --ignore custom/ .— 132/142 PASS (10 pre-existing failures ineu_fairness_test.regoandai_600_1_test.rego, unrelated to this PR — confirmed identical results onmainwithout these changes)run.shscripts produce the verdicts documented in their respectiveexpected-output.jsonopa-checksworkflow passes (will run on push)