Docs

Documentation

Guides, references, and resources for building with XMDB.

Release Notes

Pilot release notes

This pilot release bundles the pilot-ready documentation, SDKs, and smoke validation steps for XMDB core.

Highlights

  • Pilot handoff, deployment, runbook, quickstart, and release checklists.
  • Security hardening checklist and known limits guidance.
  • OpenAPI spec for pilot endpoints.
  • TypeScript and Python SDKs with typed core/v1 coverage and smoke scripts.
  • Audit verification guide and operator troubleshooting.

Key docs

  • docs/PILOT_HANDOFF.md
  • docs/PILOT_DEPLOYMENT.md
  • docs/PILOT_RUNBOOK.md
  • docs/PILOT_QUICKSTART.md
  • docs/PILOT_RELEASE_CHECKLIST.md
  • docs/SECURITY_HARDENING.md
  • docs/KNOWN_LIMITS.md
  • docs/SUPPORT_CHECKLIST.md
  • docs/PILOT_ENV_TEMPLATE.md
  • docs/AUDIT_VERIFICATION.md
  • docs/OPENAPI.md
  • docs/openapi.yaml
  • docs/SDK_REFERENCE.md
  • docs/SDK_RELEASE_CHECKLIST.md
  • docs/UPGRADE.md

Latest changelog highlights

  • FTS OR + prefix matching for multi-word queries (prevents 0-result AND defaults).
  • Hybrid vector fallback when FTS returns 0 candidates (for /query and /pack).
  • Typed entries (type_hint stored as type with note, decision, task, event, insight).
  • Recall evaluation tests added (TestRecallEvalFTS, hybrid fallback regression test).

Suggested validation

  • Run the SDK smoke scripts (TypeScript + Python).
  • Verify packs and receipts using xmdbctl.
  • Confirm /health and /metrics.

Ready to add durable memory?

Get started with XMDB today.