docs: add living system design - #210
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR shifts architectural documentation from historical ADRs to a set of indexed, “living” design docs under design/, and updates the CLI docs to clarify that --select affects local presentation (not server-side response shaping).
Changes:
- Add a new
design/documentation set covering spaces/provisioning, principals/auth, API-key scoping, harness integrations, migrations/versioning, embeddings, and presentation/field projection. - Convert existing ADR-styled design docs into living references (remove ADR metadata sections and reframe as invariants/constraints).
- Update
me memory search --selectdocumentation to state the default text view is locally projected.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/cli/me-memory.md | Clarifies that default text search output is locally projected rather than requested as a partial response. |
| design/README.md | Adds an index for the living design documentation set. |
| design/spaces.md | Documents space identity, provisioning defaults, custom provisioning flags, invitations, and lifecycle. |
| design/principal-model.md | Defines principal vs member terminology and the user/group/service-account model (including rationale for removing agent principals). |
| design/memory-authorization.md | Documents membership vs data access, grant levels, effective access computation, and delegation model. |
| design/restricted-api-keys.md | Documents restricted key declarations as a server-enforced ceiling and their effective-authority intersection rules. |
| design/harness-integrations.md | Describes harness integration layering, directory-scoped activation policy, and the shared runtime contract. |
| design/harnesses/claude.md | Documents Claude Code adapter behavior for env injection, MCP, and capture hooks. |
| design/harnesses/opencode.md | Documents OpenCode adapter behavior for env injection, MCP, and capture triggers. |
| design/harnesses/codex.md | Documents Codex adapter command-rewrite hook behavior and provider constraints. |
| design/database-migrations-and-versioning.md | Documents schema families, incremental vs idempotent migrations, startup reconciliation, and signature-guarded functions. |
| design/embedding-queue-and-worker.md | Documents per-space embedding queues, claiming/retries, staleness, and operational reporting. |
| design/field-projection-and-format-selection.md | Documents CLI/MCP presentation-only selection/format behavior and selector rules. |
| design/semantic-search-scoring.md | Reframes semantic score behavior as invariants/constraints (cosine similarity, threshold bounds). |
| design/hnsw-filtered-semantic-search.md | Reframes filtered semantic search behavior and constraints around iterative scans. |
| design/fulltext-bm25-scoring.md | Reframes BM25 positive-match invariant and its role in hybrid search. |
| design/hybrid-rrf-scoring.md | Reframes RRF fusion model, determinism constraints, and tuning boundaries. |
| design/jsonpath-metadata-predicates.md | Reframes metaPredicate as a PostgreSQL-native filter with documented constraints and compatibility requirements. |
| adr/README.md | Removes the ADR index in favor of the new living design documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Summary
Verification
./bun run check./bun run check:full(blocked: local PostgreSQL at 127.0.0.1:5432 lacks thepostgresrole; the repositoryme-postgrescontainer could not start because that port is occupied)