CR-README-01: reposition README + PyPI to organisational intelligence - #257
Merged
Merged
Conversation
Public port of private PR #341 (merged 2026-09-14, merge commit 06a2527a). Scoped to the four files the CR owns; content is byte-identical to private/master. Repositions the public GitHub README and the PyPI package page away from EU-AI-Act-first governance toward persistent organisational intelligence. Governance is re-ranked, never removed: it becomes the trust layer that makes the intelligence safe to act on, rather than the category headline. POSITIONING - Hero: "give your AI a memory of how your organisation actually works" — codebases, documents, policies, decisions and workflows into one typed graph. Removes "runtime governance for regulators" from the first screen. - Moves higher: model independence, MCP-first, the compounding advantage. - Moves lower: runtime attestation, cryptographic substrate, token economics, and the EU AI Act section (first mention now line 251 of 328, was line 13). - Broadens compliance beyond the EU: SOX/COSO (the shipped x-sox pack), ISO/IEC 42001, GDPR claim limits, and packs-as-data for NIST AI RMF / SOC 2 / HIPAA. ADR-MARKETING-001 is fully respected. Every locked marker stays IN README.md — the EU AI Act-aligned badge, the literal "Articles 6, 9, 12, 13, 14, 15, 25, 50" scope string, and both NOT-claims — relocated into the Regulated deployments section. test_readme_snapshot_lock passes 62/62 on this tree. OPERATIONAL FIXES (each defect reproduced before fixing) - PyPI served the wrong file: pyproject pointed readme at README.md, so the concise README_PYPI.md never reached PyPI. Pointer switched; verified in the BUILT WHEEL's METADATA, not in source. - Broken quickstart: both READMEs published `graq learn "<text>"`, which errors with "No such command". Corrected to `graq learn knowledge "<fact>"`. - A second non-existent command: both READMEs published `graq lessons <domain>`. The real surface is `graq learned`. Caught by machine-diffing every README command against `graq --help` — it survived manual review. - Wrong counts: MCP tools published as "76+" / "74"; `graq mcp tools --json` reports 85 graq_ tools (+83 kogni_ aliases). "14 backends" counted Azure OpenAI, which has no preset, no registry entry and no backend class — corrected to 13 named + custom HTTP. - Placeholder answers carried a confidence score: with no LLM configured, MockBackend emitted "Confidence: NN%" beside placeholder text, which is indistinguishable from a governed answer. The fallback branch no longer reports a confidence figure; the explicit-response branch is untouched. VERIFICATION ON THIS PUBLIC TREE - test_readme_snapshot_lock + test_eu_ai_act_docs_present: 62 passed. - Every graq command quoted in both READMEs machine-diffed against `graq --help`: 0 invalid. - Forbidden-word scan (compliant/certified/guaranteed/end-to-end solution): 0 violations in both files. - No stale counts (76+/74/14/Azure OpenAI/graq lessons) remain. NOTE ON PyPI: v0.83.0 is already tagged and was published on 2026-07-31, so the live PyPI page still renders the old README. This copy reaches PyPI only on the next version bump — the README_PYPI pointer change takes effect then. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
🛡️ GraQle PR Guardian💥 Blast Radius: 4 modules affected
Total blast radius: 4 🏛️ Governance Verdict
|
| Metric | Value |
|---|---|
| Blast Radius | 4 |
| Files Analyzed | 4 |
| Blocked | 0 |
| SHACL Violations | 0 |
| Verdict | WARN |
🔬 Powered by GraQle PR Guardian v0.1.0 · Scan completed 2026-09-14T12:58:13.330161+00:00
harishquantamix
approved these changes
Sep 14, 2026
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.
What this changes
Repositions the public GitHub README and the PyPI package page away from EU-AI-Act-first governance toward persistent organisational intelligence.
Governance is re-ranked, never removed: it becomes the trust layer that makes the intelligence safe to act on, rather than the category headline.
Public port of private PR #341 (merged 2026-09-14, merge commit
06a2527a). Scoped to the four files this CR owns; content is byte-identical toprivate/master.Positioning changes
x-soxpack) + ISO/IEC 42001 + GDPR claim limits + packs-as-data for NIST AI RMF / SOC 2 / HIPAAThe page now reads for a developer in San Francisco, Bangalore, Amsterdam, Singapore or Sydney who has no EU compliance requirement — while losing none of the regulated-market advantage.
ADR-MARKETING-001 is fully respected
tests/test_compliance/test_readme_snapshot_lock.pyis a merge gate pinning public positioning. Every locked marker stays INREADME.md— the EU AI Act–aligned shields.io badge, the literalArticles 6, 9, 12, 13, 14, 15, 25, 50scope string, and both NOT-claims — relocated into the Regulated deployments section rather than deleted.62/62 lock tests pass on this tree. No ADR amendment required.
Operational fixes (each defect reproduced before fixing)
PyPI served the wrong file.
pyproject.tomlpointedreadmeatREADME.md, so the conciseREADME_PYPI.mdnever reached PyPI. Pointer switched. Verified in the built wheel's METADATA, not in source.Broken quickstart command. Both READMEs published
graq learn "<text>", which errors withNo such command—learnis a Typer sub-app with no bare-string callback. Corrected tograq learn knowledge "<fact>", verified end-to-end on a cold project.A second non-existent command. Both READMEs published
graq lessons <domain>. That command does not exist; the real surface isgraq learned. Caught by machine-diffing every README command againstgraq --help— it survived manual review.Wrong counts.
graq mcp tools --jsonreports 85graq_tools (+83kogni_aliases).Placeholder answers carried a confidence score. With no LLM configured,
MockBackendemittedConfidence: NN%beside "[NO LLM CONFIGURED … placeholder …]" — indistinguishable from a governed answer to anyone skimming output, and corrosive to every decision-grade claim on the page. The fallback branch no longer reports a confidence figure; the explicit-response branch is untouched.Verification on this tree
test_readme_snapshot_lock+test_eu_ai_act_docs_presentgraqcommand quoted in both READMEs, machine-diffed againstgraq --helpcompliant/certified/guaranteed/end-to-end solution)76+/74/14/Azure OpenAI/graq lessons)private/masterOn the private PR the same change also passed: 931 compliance/packaging/backend tests, 145 backend tests after the mock change, ruff clean, wheel build with correct METADATA, and both fresh-install smoke tests (ubuntu + windows).
Claims verified before any copy was written
Every broad claim was run before it was published:
graq scan docs+graq learn docon a real.docx+.md→ 2 files → 41 nodes (2 DOCUMENT + 39 SECTION) withSECTION_OFedges, auto-linked to code. PDF/DOCX/PPTX/XLSX requirepip install graqle[docs]; the README says so plainly.sentence-transformersis not a core dependency — a default install falls back to a zero-dependency hash embedder and makes no network call. Unauthenticatedgraq scan repoperforms no cloud sync.IMPORTS/CALLS/DEFINESedges.Note on PyPI timing
v0.83.0is already tagged and was published to PyPI on 2026-07-31, so the live PyPI page still renders the old README. This copy reaches PyPI only on the next version bump — that is when theREADME_PYPI.mdpointer change takes effect. Merging this PR fixes the GitHub page immediately; the PyPI page follows at the next release.Files changed (4)
README.md— full rewrite against the strategy review's 13-section information architectureREADME_PYPI.md— conversion-optimised, materially shorter, and now actually shipped to PyPIpyproject.toml—readmepointer, description, category keywords (all existing code keywords retained)graqle/backends/mock.py— placeholder confidence-score fix (the only code change)🤖 Generated with Claude Code