Skip to content

docs(readme): second-wave Why→Docs unify + P0 framing - #6

Merged
tangyf07 merged 1 commit into
mainfrom
docs/readme-template-v2
Sep 8, 2026
Merged

docs(readme): second-wave Why→Docs unify + P0 framing#6
tangyf07 merged 1 commit into
mainfrom
docs/readme-template-v2

Conversation

@tangyf07

@tangyf07 tangyf07 commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Restructure README first-screen to Why → Architecture → Guarantees → Quickstart → Evidence → Design decisions → Limitations → Docs (title/blurb kept above Why).
  • Reflect merged P0: HTTP serve server-locked (policy/catalog/db/env at startup; body cannot override) + audit SQL default redaction (SQL_WRITE_GATE_AUDIT_SQL_MODE).
  • Suite narrative: third ring (RetailDW → GameStream → SQLGuard); engineering exploration for data-consumption safety — not flagship feat(sqlguard): v1.1.0 AST, permissions, risk score, DataPilot API #1. No recruiting framing.
  • Keep make seal + evidence pointer, 非生产唯一边界 / fail-closed. CHANGELOG: Unreleased docs note; annotate superseded 1.1.2 body-override honest-boundary.

Test plan

  • Skim README first screen section order
  • Confirm no leftover 「HTTP binding is not server-locked」 / body-may-override reader framing
  • Confirm SEAL.md / make seal pointer still present
  • Docs-only diff (README + CHANGELOG)

Restructure first-screen to Why → Architecture → Guarantees →
Quickstart → Evidence → Design decisions → Limitations → Docs.
Reflect P0 server-locked HTTP serve + audit SQL redact; suite
third-ring narrative (RetailDW → GameStream → SQLGuard). Annotate
superseded 1.1.2 body-override honest-boundary in CHANGELOG.
@tangyf07
tangyf07 merged commit 39922d6 into main Sep 8, 2026
2 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.

1 participant