Skip to content

docs: SHELET v0.4.0 README — stratification, citations, comparison, FAQ - #5

Open
mordechaipotash wants to merge 1 commit into
mainfrom
docs/shelet-v0.4.0-readme
Open

docs: SHELET v0.4.0 README — stratification, citations, comparison, FAQ#5
mordechaipotash wants to merge 1 commit into
mainfrom
docs/shelet-v0.4.0-readme

Conversation

@mordechaipotash

Copy link
Copy Markdown
Owner

Summary

Rewrites the README for the v0.4.0 SHELET release.

Key changes

  • Lead reframed: from "your AI has amnesia" to "the first SHELET-compliant MCP server" with structural citation discipline
  • New "The SHELET Architecture" section: L0/L1/L2/L3 table, governing rule, enforcement mechanisms (CHECK constraints + RLS + skill manifests + verify-skills CI), brain.resolve_citations(l3_id)
  • Citation discipline sub-section in "For AI Assistants": explicit correct/wrong examples + ban on stripping citations
  • 25-tool table stratified by SHELET layer (L0/L1/L2/L3/utility) instead of the flat category list
  • Example tunnel_state output updated to show real [conv_id · YYYY-MM-DD] citations on every bullet
  • New "Compared to" comparison table vs mem0 / Letta / Zep / Rewind / Obsidian / official MCP memory across 7 capability axes
  • New 8-question FAQ: privacy, SHELET, vs-competitors, embedding swap, fallback behavior, upgrades, multi-tenant, contributing
  • Cross-links added: ADR-001, ADR-002, Migration 003, Changelog

Honest corrections

Several claims in the old README didn't match v0.4.0 reality:

  • Sync: old README claimed "automatic sync, no cron jobs"; v0.3.1 disabled auto-sync because it clobbered historical imports. New section explains the why and makes manual sync the stated contract.
  • Windsurf: old README claimed native auto-detect; no Windsurf ingester exists. New section marks it "uses Cursor ingester pattern".
  • "12ms": unverifiable marketing claim; replaced with "sub-second local queries" which is honest.

Net diff

261 insertions, 131 deletions across README.md only. No code changes.

Test plan

  • Spot-check formatting on GitHub (tables, collapsible <details>, code blocks)
  • Verify all internal links resolve:
    • #-for-ai-assistants, #-for-humans, #install, #the-shelet-architecture, #compared-to, #faq
    • docs/adr/001-shelet-reference-implementation.md
    • docs/adr/002-supabase-canonical-backend.md
    • supabase/migrations/003_shelet_l0_to_l3.sql
    • scripts/verify_skills.py, CHANGELOG.md, LICENSE
  • Verify external links: brainmcp.dev, brainmcp.dev/for-ai, PyPI, telemetry page

🤖 Generated with Claude Code

Updates the README for the v0.4.0 release, centered on the SHELET reference
implementation framing that shipped in PR #3 + PR #4.

Key changes:
- Lead reframed: "first SHELET-compliant MCP server" with structural citation
  discipline, not just "your AI has amnesia"
- New "SHELET Architecture" section explaining L0→L3 stratification, the
  governing rule, and enforcement (CHECK constraints, RLS, skill manifests,
  verify-skills CI)
- "For AI Assistants" — added explicit citation discipline section with
  correct/wrong examples and the ban on stripping citations
- 25-tool table flattened and stratified by L0/L1/L2/L3/utility layer
- Example tunnel-state output updated to show real [conv_id · date] citations
- New "Compared to" comparison table vs mem0 / Letta / Zep / Rewind / Obsidian
  / official MCP memory — 7 capability axes
- New 8-question FAQ (privacy / SHELET / vs-competitors / embedding swap /
  fallback / upgrades / multi-tenant / contributing)
- Cross-links to ADR-001, ADR-002, Migration 003
- Honest corrections:
  - Auto-sync section now says manual sync is the contract (was: claimed
    automatic sync; auto-sync was disabled in v0.3.1)
  - Windsurf marked "uses Cursor ingester pattern" (was: false claim of
    native auto-detect)
  - Removed unverified "12ms" marketing claim in favor of "sub-second"

Net: 261 insertions, 131 deletions on README.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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