Skip to content

docs: compliance-claim discipline pass (#122)#159

Merged
sergeyenin merged 1 commit into
mainfrom
docs/claim-discipline-122
Jun 2, 2026
Merged

docs: compliance-claim discipline pass (#122)#159
sergeyenin merged 1 commit into
mainfrom
docs/claim-discipline-122

Conversation

@sergeyenin
Copy link
Copy Markdown
Contributor

@sergeyenin sergeyenin commented Jun 2, 2026

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

  • Adds a "Compliance-claim discipline (required)" section to CONTRIBUTING.md: always "supporting controls / evidence for <article>", never "GDPR compliant" / "makes you compliant" / "ensures/guarantees compliance". Links to LIMITATIONS.md and internal/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.sh fails on outcome phrases ("makes you compliant", "guarantees compliance", "fully compliant", "N days to compliant", ...). Wired into the Docs workflow. Excludes LIMITATIONS.md / CONTRIBUTING.md, which quote the banned phrases as negative examples.
  • Also added LIMITATIONS.md to the markdown link-check scope.

Closes #122.

Test plan

  • bash scripts/check-claim-discipline.sh passes on the current tree.
  • Guard regex catches "makes you compliant" / "N days to Compliant" / "fully compliant" / "guarantees GDPR compliance" and allows quoted dialogue + "supporting controls for GDPR Art. 32".
  • go build ./internal/pack/... succeeds.
  • Docs workflow (link check + claim guard) passes in CI.

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.md adds a required section (always pair features with articles; never "GDPR compliant" / "makes you compliant" / guarantees). It points to LIMITATIONS.md and internal/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.md and the hidden Flowise pack string in internal/pack/wizard.go drop outcome-style GDPR claims.

CI enforcement: New scripts/check-claim-discipline.sh greps public markdown for banned outcome phrases (with exclusions for LIMITATIONS.md / CONTRIBUTING.md negative examples). The Docs workflow runs it and adds LIMITATIONS.md to markdown link-check file-path.

Reviewed by Cursor Bugbot for commit 4adcf49. Configure here.

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
@sergeyenin sergeyenin merged commit ee0ae04 into main Jun 2, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Compliance-claim discipline pass (style rule + docs audit + feature/article pairing)

1 participant