Skip to content

docs(readme): final trim to Why→Limitations seven sections - #7

Merged
tangyf07 merged 1 commit into
mainfrom
docs/readme-final-trim
Sep 8, 2026
Merged

tangyf07 merged 1 commit into
mainfrom
docs/readme-final-trim

Conversation

@tangyf07

@tangyf07 tangyf07 commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Trim README main body to title/blurb + Why / Architecture / Guarantees / Quickstart / Evidence / Design decisions / Limitations only.
  • Move Install, Entrypoints/API, and support-matrix depth into docs/install.md, docs/api.md, docs/support-matrix.md; minimal See also links after Limitations.
  • Remove Suite 第三环 / 作品集旗舰 meta; keep one engineering sentence that SQLGuard complements RetailDW/GameStream.
  • Preserve make seal + evidence, 非生产唯一边界, P0 HTTP server-lock, and audit redact facts so CI README assertions stay green.

Test plan

  • pytest README-related tests (test_readme, v100 pilot-ready, v022 deployment/matrix, v023 troubleshooting link, v101 docs blob)
  • CI green on PR
  • Do not merge until review

Move Install / API / support matrix into docs/; drop Suite meta narrative;
keep seal, evidence, 非生产唯一边界, P0 HTTP lock, and audit redact facts.
@tangyf07
tangyf07 merged commit a869559 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