docs: define llm and actor input/output interfaces#131
Open
Myriad-Dreamin wants to merge 30 commits intoEmaFanClub:mainfrom
Open
docs: define llm and actor input/output interfaces#131Myriad-Dreamin wants to merge 30 commits intoEmaFanClub:mainfrom
Myriad-Dreamin wants to merge 30 commits intoEmaFanClub:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR establishes the foundational architecture for EverMemoryArchive by defining core interface contracts. It introduces a conceptual module that documents how different system components (UI, Actor, LLM, Storage) interact through well-defined TypeScript interfaces.
Key changes:
- Introduces interface definitions for Actor client, LLM client, and storage components in a new
conceptmodule - Adds type-checking utilities for compile-time interface validation
- Updates documentation generation to include the new concept module and adds Mermaid diagram rendering support
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/docs.js |
Refactored to include the new concept module in documentation generation |
packages/ema/src/types.ts |
Added type-checking utilities for interface validation |
packages/ema/src/concept/storage.ts |
Defined interfaces for actor state storage and memory management |
packages/ema/src/concept/llm.ts |
Defined interface for LLM client interactions |
packages/ema/src/concept/index.ts |
Module entry point with architecture documentation and Mermaid diagram |
packages/ema/src/concept/actor.ts |
Defined Actor client interface with event-based communication |
packages/ema/src/actor.ts |
Updated import to use new concept module location |
docs/.vitepress/config.js |
Added Mermaid.js integration for rendering diagrams in documentation |
05b3dcc to
f2eed2b
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
163b41c to
f7b9c6c
Compare
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.
This PR adds the concept of the EverMemoryArchive.
ActorClient.EmaLLMClient.Agent.AgentSchedulerby providingAgentTask.