Hare/yoi
1
1
Fork 0
Code Actions Packages Releases Activity

docs: consolidate design documentation and standardize crate English

Browse Source
This commit is contained in:
Hare
2026-10-12 14:58:00 +09:00
parent a633a53274
commit 4efb0ace1f
404 changed files with 4556 additions and 11654 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/memory/README.md
+7 -19
View File
@@ -1,23 +1,11 @@
# memory
## Role
Defines shared Memory schemas, extraction candidates, evidence, and typed communication.
Does not own persistence or implicitly convert between legacy single-document Workspace Memory and per-subject Memory.
`memory` owns the shared types used by Workspace-backed Memory operations:
## Main entry points
- Memory API request/response DTOs
- extraction candidate and evidence schemas
- audit event schemas
- pure Memory document frontmatter schemas and parsing helpers
## Boundaries
The crate does **not** own persistence. Workspace Memory records, staging candidates, and audit observations are stored by the Workspace Server control plane and accessed by Workers through typed API operations.
The crate intentionally contains no repository-local layout, cwd/ancestor discovery, resident-file reader, staging writer, audit/usage log writer, generic filesystem scope helper, or local backend executor. The product CLI does not expose `yoi memory lint`.
Memory is useful context, not implementation authority. Tickets, Objectives, repository files, Git history, and append-only session records remain the exact evidence surfaces for implementation state.
## See also
- [`../../docs/design/memory-knowledge.md`](../../docs/design/memory-knowledge.md)
- [`../../docs/development/work-items.md`](../../docs/development/work-items.md)
- [`backend`]: legacy Workspace Memory operation contracts and resident responses
- [`extract`]: candidate extraction and progress pointers
- [`schema`]: shared document and evidence types
- [`audit`]: audit-event transport types