docs: compliance-claim discipline pass (#122)#159
Merged
Conversation
Remove compliance-outcome language from public docs and replace it with under-claimed "supporting controls / evidence for <article>" wording: - docs/ADOPTION_SCENARIOS.md: "Compliant" framing -> "Governed"; "now GDPR + NIS2 compliant" -> "has supporting controls and evidence for GDPR + NIS2"; "prove compliance" -> "show auditors evidence". - docs/VENDOR_INTEGRATION_GUIDE.md: "Making Vendors Compliant" -> "Governing Vendors"; closing line no longer claims Talon "makes them compliant" and notes the determination stays with the data controller. - internal/cache/README.md: "GDPR Article 17 compliant" -> "supports GDPR Article 17 controls". - internal/pack/wizard.go: pack description uses "supporting controls for GDPR" instead of "GDPR-compliant". Quoted compliance-officer/vendor dialogue is kept (it reinforces the skeptical-buyer message and is not a Talon claim). Adds the claims style rule to CONTRIBUTING.md and a CI guard (scripts/check-claim-discipline.sh, wired into the Docs workflow) that fails on outcome phrases like "makes you compliant", "guarantees compliance", or "N days to compliant". Also adds LIMITATIONS.md to the markdown link-check scope. Closes #122
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
Compliance-claim discipline pass (proof-bar area 4), now unblocked by the merged
LIMITATIONS.md(#117). Removes compliance-outcome language from public docs and enforces the rule going forward.Style rule + policy
CONTRIBUTING.md: always "supporting controls / evidence for<article>", never "GDPR compliant" / "makes you compliant" / "ensures/guarantees compliance". Links toLIMITATIONS.mdandinternal/compliance/mapping.go.Docs audit (outcome language -> supporting-controls language)
docs/ADOPTION_SCENARIOS.md: "Compliant" framing -> "Governed"; "now GDPR + NIS2 compliant" -> "has supporting controls and evidence for GDPR + NIS2"; "prove compliance" -> "show auditors evidence".docs/VENDOR_INTEGRATION_GUIDE.md: title "Making Vendors Compliant" -> "Governing Vendors"; closing line no longer claims Talon "makes them compliant" and notes the determination stays with the data controller.internal/cache/README.md: "GDPR Article 17 compliant" -> "supports GDPR Article 17 controls".internal/pack/wizard.go: pack description "GDPR-compliant" -> "supporting controls for GDPR".Quoted compliance-officer / vendor dialogue is intentionally kept — it reinforces the skeptical-buyer message and is not a Talon claim. Provider metadata fields named
GDPRCompliant(self-declared, "verified only") are left as-is.CI guard (optional per issue, included)
scripts/check-claim-discipline.shfails on outcome phrases ("makes you compliant", "guarantees compliance", "fully compliant", "N days to compliant", ...). Wired into the Docs workflow. ExcludesLIMITATIONS.md/CONTRIBUTING.md, which quote the banned phrases as negative examples.LIMITATIONS.mdto the markdown link-check scope.Closes #122.
Test plan
bash scripts/check-claim-discipline.shpasses on the current tree.go build ./internal/pack/...succeeds.Note
Low Risk
Documentation and contributor guidelines only, plus a non-runtime docs CI script; no product behavior or security paths change.
Overview
This PR tightens compliance-claim discipline across public-facing material: docs and copy must describe supporting controls / evidence for specific articles, not compliance outcomes.
Contributor policy:
CONTRIBUTING.mdadds a required section (always pair features with articles; never "GDPR compliant" / "makes you compliant" / guarantees). It points toLIMITATIONS.mdandinternal/compliance/mapping.go.Wording pass: Adoption and vendor guides reframe "compliant" paths as governed, describe post-Talon state as controls + evidence (not "now compliant"), and clarify the data controller owns the legal determination.
internal/cache/README.mdand the hidden Flowise pack string ininternal/pack/wizard.godrop outcome-style GDPR claims.CI enforcement: New
scripts/check-claim-discipline.shgreps public markdown for banned outcome phrases (with exclusions forLIMITATIONS.md/CONTRIBUTING.mdnegative examples). The Docs workflow runs it and addsLIMITATIONS.mdto markdown link-checkfile-path.Reviewed by Cursor Bugbot for commit 4adcf49. Configure here.