docs(public): replace internal milestone jargon with customer-facing terms#28
Merged
Merged
Conversation
…terms Phase A / Phase C/D / PR 5 are internal development milestone labels that don't belong in customer-facing surfaces. Replaces: - README.md (PyPI long_description): "Phase A voice-session artifact" → "voice-session attestation artifact"; "Phase C/D checks" → "full lifecycle chain-walking"; "Phase A voice-session attestation" → "Voice-session attestation" - keel_verifier/cli.py help text: "PR 5 outcomes" → "Verifier output v3.0 outcomes"; "Render a PR 5 verifier_output.v3.0 JSON document" → "Render a verifier_output.v3.0 JSON document" - keel_verifier/verifier_output_render.py docstring: "PR 5 verifier output rendering" → "Verifier output v3.0 rendering" - keel_verifier/verifier.py internal comments: "Phase A artifact" → "voice-session artifact"; "Phase A voice attestation" → "voice-session attestation" - CHANGELOG.md v3.0.0 / v2.7.0 / v2.6.0 / Unreleased entries: drop internal milestone prefixes, keep dates and semantic meaning No code logic changes. No API contract changes. No version bump (docs- only cleanup; users see identical behavior). Historical CHANGELOG entries at v1.0.0 lines 239-241 retain Phase C/D language; those describe the original feature introduction and rewriting them would be revisionist. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Why
README.md is the PyPI long_description — every customer browsing https://pypi.org/project/keel-verifier/ currently sees "Phase A voice-session artifact" and "Phase C/D checks". The
keel-verify render --helpoutput shows "PR 5" to every user who runs it. These are internal development milestone labels that have no meaning to a customer.What changed (5 surface categories)
README.md(PyPI long_description)keel_verifier/cli.pyhelp textkeel_verifier/verifier_output_render.pydocstringkeel_verifier/verifier.pycomments (4 sites)CHANGELOG.mdv3.0.0 / v2.7.0 / v2.6.0 / UnreleasedWhat was intentionally left alone
spec_section_anchorvalues insideOUTCOME_RENDER_MAPPINGS— internal anchor strings for dashboard tooling.No logic changes
Pure documentation/string cleanup. No API contract changes. No version bump required — behavior is identical.
Distribution impact
This fixes the PyPI long_description on next release. Existing pinned versions on PyPI are immutable.
Recommend cutting a patch release (v3.0.1) after merge to push the cleaned README to PyPI immediately.
Test note
One pre-existing test failure (
test_hash_mismatch_is_insufficient_with_top_level_integrity_error) fails because it expects a fixture file at/private/tmp/keel-permit/semantics/export_manifest/integrity_v1.jsonwhich is absent in this environment. Confirmed pre-existing onorigin/mainbefore any edits. All other 178 tests pass, 38 skipped.