Repository navigation
docs: reflect platform-agnostic architecture, usage, and structure - #11
Merged
Merged
Conversation
Update the README and docs now that the orchestrator core is platform-agnostic (ports-and-adapters) with two runtimes and pluggable LLM providers. - README: dual-runtime overview (Cloudflare edge vs local Node, no account needed), LLM provider table + config env vars, local `dev:local` quick start, SSE-vs-WebSocket streaming note, refreshed project structure, scripts, docs table, and an Examples section (crypto-payments, fastapi client, task UI). - architecture.md: add "Portable Architecture (Ports & Adapters)" — the three ports (AgentRuntime, StateStore, LlmProvider) and their adapters, a two-runtime comparison, bounded-concurrency note, and a pluggable-LLM-providers section; extend the component map with the core/providers/runtime/local components. - technical-summary.md: mark the root typecheck (PR #9) and test-environment (PR #10) follow-ups as resolved. Co-authored-by: Cursor <cursoragent@cursor.com>
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
Refreshes the README and docs now that the orchestrator core is platform-agnostic (ports-and-adapters) with two runtimes and pluggable LLM providers. Documentation-only — no code changes.
LLM_PROVIDER,LLM_API_KEY,LLM_MODEL,LLM_BASE_URL).npm run dev:localquick start; SSE-vs-WebSocket streaming note.core/,providers/llm/,runtime/,local/, examples), Scripts, Documentation table, and a new Examples section.AgentRuntime,StateStore,LlmProvider) and adapters, a two-runtime comparison table, bounded-concurrency note, and a Pluggable LLM Providers section.Verification
.wolf/session-metadata churn.Test plan
Made with Cursor