docs: carry the technical-voice pass into the surfaces #88 did not touch - #89
Merged
Conversation
#88 rewrote README.md, README-pypi.md and the CLI help. The same pass had been prepared for the explanatory docs, the examples index, the translated READMEs and the diagrams, on a branch that was never opened as a pull request. Those nineteen files are carried across here. The three files #88 already rewrote are deliberately excluded, so nothing merged in #88 is reverted. The diagrams correct a mismatch #88 introduced. #88 updated the policy count in the README alt text to 92, but the count a reader sees is rendered inside the SVG, which still read 91. diagram2 and diagram3 now read 92 in both themes, so the images agree with the prose. diagram1 and diagram5 relabel "audit-ready report" as "evidence report", matching the language the README now uses. The four translated READMEs carry one correction each: pyproject declares requires-python = ">=3.12,<3.13", so the "Python 3.12+" badge overstated the supported range. It now reads 3.12. The English surfaces still carry the same overstatement and are corrected separately. docs/INDEX.md, docs/adapters.md, docs/integrations/github-actions.md, docs/why-aicertify.md, docs/writing-an-evaluator.md and examples/README.md receive the register pass only. No figure, threshold, command or link target changes in those six files. The submodule moves from 0482ec9 to 4321e7a, which is the v2.0.0 tag. The branch that set the previous pin was named for 2.0.0 but pinned the commit before the tag. The two trees differ by one comment line in helper_functions/declarations.rego, correcting 171 to 170 fields; no policy behaviour changes, and coverage totals stay at 92 policies, 92 with tests and 92 with empty-input tests. Verified: no "91 policies" string remains in any tracked file, every relative link in the six carried docs resolves, and the submodule checks out at v2.0.0.
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.
🚀 Overview
Carries the technical-voice documentation pass into the 19 surfaces #88 did not
touch.
README.md,README-pypi.mdandaicertify/cli.pyare deliberatelyexcluded, so nothing merged in #88 is reverted.
This work existed on
docs/technical-voice(5ab4d11), which branched from thesame base as #88 and was never opened as a PR. That branch can be deleted once
this and its companion corrections PR are merged.
📜 Changes Made
v2.0.0tagThe diagram mismatch
#88 updated the policy count to 92 in the README alt text. The count a
reader actually sees is rendered inside the SVG, which still read 91.
maincurrently says 92 in four places of prose and 91 in four rendered images.diagram2anddiagram3now read 92 in both themes.diagram1anddiagram5relabel "audit-ready report" as "evidence report", matching the README's
language.
Translated READMEs
pyproject.tomldeclaresrequires-python = ">=3.12,<3.13"— 3.12 only. The"Python 3.12+" badge overstated the supported range. Corrected to 3.12 in all
four translations. The English README and PyPI page still carry the same
overstatement and are fixed in the companion PR, together with four other
defects.
Prose-only files
docs/INDEX.md,docs/adapters.md,docs/integrations/github-actions.md,docs/why-aicertify.md,docs/writing-an-evaluator.md,examples/README.md.No figure, threshold, command or link target changes in these six.
Submodule
0482ec9→4321e7a, which is thev2.0.0tag. The branch that set theprevious pin was named for 2.0.0 but pinned the commit before the tag.
The two trees differ by one comment line in
helper_functions/declarations.rego(171 → 170 fields). No policy behaviourchanges. Coverage totals are unchanged at
policies: 92, policies_with_tests: 92, policies_with_empty_input_test: 92.🎯 How to Test
Verified locally: no
91 ... policiesstring remains in any tracked file, everyrelative link in the six carried docs resolves, and the submodule checks out at
v2.0.0.📚 Documentation