diff --git a/docs/c4/model.json b/docs/c4/model.json new file mode 100644 index 0000000..3461483 --- /dev/null +++ b/docs/c4/model.json @@ -0,0 +1,21 @@ +{ + "version": "1.0", + "scope": "soul-protocol", + "generated_at": "2026-05-29T10:10:44Z", + "source_path": "/Users/prakash-1/Documents/paw-workspace/soul-protocol", + "model": { + "people": [], + "systems": [ + { + "id": "soul-protocol", + "name": "Soul Protocol", + "description": "Software system: soul-protocol", + "tags": [ + "internal" + ], + "containers": [] + } + ], + "relationships": [] + } +} \ No newline at end of file diff --git a/docs/c4/views/components/soul-protocol-core.json b/docs/c4/views/components/soul-protocol-core.json new file mode 100644 index 0000000..6198996 --- /dev/null +++ b/docs/c4/views/components/soul-protocol-core.json @@ -0,0 +1,312 @@ +{ + "level": "component", + "title": "Components -- Soul Protocol", + "description": "Component-level view of Soul Protocol", + "elements": [ + "adapters", + "assets", + "bridges", + "cognitive", + "context", + "crypto", + "dimensions", + "dna", + "dspytraining", + "embeddings", + "engine", + "eternal", + "eval", + "evalui", + "evolution", + "examples", + "export", + "identity", + "importers", + "journal", + "longhorizon", + "mcp", + "memory", + "parsers", + "providers", + "quality", + "research", + "runtime", + "scripts", + "soul-agent", + "soulprotocol", + "spec", + "spike", + "state", + "storage", + "templates", + "testcli", + "testcognitive", + "testembeddings", + "testengine", + "testeternal", + "testevolution", + "testimporters", + "testinstall", + "testlonghorizon", + "testmcp", + "testmemory", + "testmodels", + "tests", + "testspec", + "testspike", + "teststate", + "teststorage" + ], + "relationships": [ + { + "source": "adapters", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "bridges", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "cli", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "cognitive", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "context", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "crypto", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "dimensions", + "target": "research", + "description": "imports research" + }, + { + "source": "dimensions", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "dna", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "dspytraining", + "target": "research", + "description": "imports research" + }, + { + "source": "embeddings", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "eternal", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "eval", + "target": "research", + "description": "imports research" + }, + { + "source": "evalui", + "target": "research", + "description": "imports research" + }, + { + "source": "evalui", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "evolution", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "examples", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "export", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "identity", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "importers", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "journal", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "longhorizon", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "mcp", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "memory", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "parsers", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "providers", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "quality", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "research", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "runtime", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "scripts", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "spec", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "spike", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "state", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "storage", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testcli", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testcognitive", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testembeddings", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testengine", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testeternal", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testevolution", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testimporters", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testlonghorizon", + "target": "research", + "description": "imports research" + }, + { + "source": "testmcp", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testmemory", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testmodels", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "tests", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testspec", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "testspike", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "teststate", + "target": "soulprotocol", + "description": "imports soul_protocol" + }, + { + "source": "teststorage", + "target": "soulprotocol", + "description": "imports soul_protocol" + } + ] +} \ No newline at end of file diff --git a/docs/c4/views/components/soul-protocol-core.md b/docs/c4/views/components/soul-protocol-core.md new file mode 100644 index 0000000..55f063b --- /dev/null +++ b/docs/c4/views/components/soul-protocol-core.md @@ -0,0 +1,11 @@ + + +# C4 — Components -- Soul Protocol — component + +Component-level view of Soul Protocol + +```mermaid +graph TB + memory(("Memory")) + testmemory(("Test Memory")) +``` diff --git a/docs/c4/views/containers.json b/docs/c4/views/containers.json new file mode 100644 index 0000000..964b681 --- /dev/null +++ b/docs/c4/views/containers.json @@ -0,0 +1,26 @@ +{ + "level": "container", + "title": "Containers -- soul-protocol", + "description": "Container-level view of soul-protocol", + "elements": [ + "cli", + "soul-protocol-core" + ], + "relationships": [ + { + "source": "cli", + "target": "soul-protocol-core", + "description": "imports soul_protocol" + }, + { + "source": "soul-protocol", + "target": "anthropic-api", + "description": "Uses Anthropic API" + }, + { + "source": "soul-protocol", + "target": "openai-api", + "description": "Uses OpenAI API" + } + ] +} \ No newline at end of file diff --git a/docs/c4/views/containers.md b/docs/c4/views/containers.md new file mode 100644 index 0000000..fc41f07 --- /dev/null +++ b/docs/c4/views/containers.md @@ -0,0 +1,9 @@ + + +# C4 — Containers -- soul-protocol — container + +Container-level view of soul-protocol + +```mermaid +graph TB +``` diff --git a/docs/c4/views/system-context.json b/docs/c4/views/system-context.json new file mode 100644 index 0000000..cd2da71 --- /dev/null +++ b/docs/c4/views/system-context.json @@ -0,0 +1,22 @@ +{ + "level": "context", + "title": "System Context -- soul-protocol", + "description": "How soul-protocol fits in its ecosystem", + "elements": [ + "soul-protocol", + "anthropic-api", + "openai-api" + ], + "relationships": [ + { + "source": "soul-protocol", + "target": "anthropic-api", + "description": "Uses Anthropic API" + }, + { + "source": "soul-protocol", + "target": "openai-api", + "description": "Uses OpenAI API" + } + ] +} \ No newline at end of file diff --git a/docs/c4/views/system-context.md b/docs/c4/views/system-context.md new file mode 100644 index 0000000..5e49e9a --- /dev/null +++ b/docs/c4/views/system-context.md @@ -0,0 +1,10 @@ + + +# C4 — System Context -- soul-protocol — context + +How soul-protocol fits in its ecosystem + +```mermaid +graph TB + soul_protocol["Soul Protocol"] +```