diff --git a/README.md b/README.md index 06b10fa..6a98ae6 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,17 @@

- PyPI - Python 3.13+ - LangGraph - MCP - OpenTelemetry + + PyPI + Python 3.13+ + LangGraph + MCP + OpenTelemetry License: Apache 2.0

@@ -41,10 +47,6 @@ you need something it lacks, you are rewriting. > carries traces. We reimplement none of them — we wire them together and add the plumbing > none of them ship. -

- AgentShip architecture -

- --- ## Quick start @@ -112,25 +114,36 @@ a kernel that imports no vendor library. Everything below is in the tree today are seams with a contract and one implementation, not roadmap. ```mermaid +%%{init: {"theme":"base","themeVariables":{ + "primaryColor":"#141C22","primaryTextColor":"#E8EEF0","primaryBorderColor":"#2A3944", + "lineColor":"#55656E","textColor":"#C9D5DB", + "clusterBkg":"#0D1317","clusterBorder":"#243039", + "edgeLabelBackground":"#141C22","tertiaryColor":"#141C22", + "fontFamily":"ui-sans-serif, system-ui, -apple-system, sans-serif","fontSize":"14px" +}}}%% flowchart TB - classDef spec fill:#fef3c7,stroke:#b45309,stroke-width:2px,color:#7c2d12 - classDef system fill:#ccfbf1,stroke:#0f766e,stroke-width:2.5px,color:#134e4a - classDef adapter fill:#dcfce7,stroke:#15803d,stroke-width:1.5px,color:#14532d - classDef ext fill:#f1f5f9,stroke:#64748b,stroke-width:1.5px,color:#334155 - classDef obs fill:#dbeafe,stroke:#1e40af,stroke-width:1.5px,color:#1e3a8a + %% Brand palette. Every node is Panel (#141C22) with Fog text; only the STROKE carries + %% meaning, so the accent is spent once — on the kernel, which is what the diagram argues + %% for. Previously five pastel fills (amber, mint, green, slate, blue) rendered this as a + %% bright light-mode block in the middle of a dark-branded README. + classDef spec fill:#141C22,stroke:#34454F,stroke-width:1.5px,color:#E8EEF0 + classDef system fill:#141C22,stroke:#A685EE,stroke-width:2px,color:#E8EEF0 + classDef adapter fill:#141C22,stroke:#5CCFC0,stroke-width:1.5px,color:#E8EEF0 + classDef ext fill:#141C22,stroke:#34454F,stroke-width:1px,color:#9FB0B9 + classDef obs fill:#141C22,stroke:#34454F,stroke-width:1.5px,color:#C9D5DB SPEC["agent.yaml
[AgentSpec]
name · engine · prompt
tools · members"]:::spec CLI["agentship-cli
[Entry point]
run · serve · doctor · verify"]:::spec SVC["agentship-service
[FastAPI]
:invoke :resume :stream
WS /live · /a2a · Studio"]:::spec - subgraph CORE["agentship-core — imports no vendor library"] + subgraph CORE["agentship-core · imports no vendor"] RT["RunnableAgent
[Runtime]
one turn: run / stream / resume"]:::system SEAM["Seams
[Contracts]
auth · tenancy · tools
observability · A2A"]:::system CONF["Conformance matrix
[Build gate]
fails on a capability
declared but not held"]:::system end - subgraph ENG["engine adapters — the only code that names a vendor"] + subgraph ENG["engine adapters"] ECHO["echo
[Engine]
no provider, no network"]:::adapter LG["langgraph
[Engine]
single · graph · autonomous"]:::adapter end @@ -153,6 +166,12 @@ flowchart TB LG --> X2 LG --> X3 CORE -->|emits spans| OBS + + %% The three containers, matching their contents: accent for the kernel, teal for the + %% adapters, dim for what we consume and never reimplement. + style CORE fill:#0D1317,stroke:#A685EE,stroke-width:1px + style ENG fill:#0D1317,stroke:#5CCFC0,stroke-width:1px + style EXT fill:#0D1317,stroke:#243039,stroke-width:1px ``` **Read it in one line:** your spec never names a vendor, the kernel never imports one, and the diff --git a/branding/Architecture.png b/branding/Architecture.png deleted file mode 100644 index 5a7d30a..0000000 Binary files a/branding/Architecture.png and /dev/null differ diff --git a/branding/README.md b/branding/README.md index ce00ab4..9c9b753 100644 --- a/branding/README.md +++ b/branding/README.md @@ -13,10 +13,16 @@ logo/favicon.ico 16/32/48 banner/ 1280x400 README banner (@2x) and 1280x640 social preview fonts/ self-hosted woff2/woff + fonts.css (SIL OFL — see Licensing) tokens/ tokens.json, tokens.css, tailwind.preset.js, mkdocs-agentship.css -hero/image.png architecture illustration used in the README (a diagram, not a logo) -Architecture.png architecture illustration (a diagram, not a logo) ``` +Two architecture illustrations used to live here, `hero/image.png` and `Architecture.png`. +Both are gone. They predated the rebuild and showed a system that does not exist — Google ADK, +OpenAI SDK and CrewAI as engines, a memory layer with vector stores, guardrails, eval datasets, +LLM-as-judge — and each carried a different old wordmark, one of them with a glow. The README's +architecture picture is now the Mermaid diagram in the README itself, which is generated from +the same facts the rest of the page is held to. If a raster diagram is needed again, draw it +from `tokens/` and keep it in step with that one. + ## Which logo | Place | File | diff --git a/branding/hero/image.png b/branding/hero/image.png deleted file mode 100644 index 5ace173..0000000 Binary files a/branding/hero/image.png and /dev/null differ diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 4395b33..25e808a 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -24,6 +24,22 @@ they were written before the project cut tagged releases. ## [Unreleased] ### Changed +- **The README's own picture advertised four things AgentShip cannot do.** `branding/hero/image.png` + sat directly under "The problem" and showed Google ADK, OpenAI SDK and CrewAI as engines, plus + Memory and Guardrails as components — against a README that states a few sections later that + none of those are built. It also carried the pre-rebuild wordmark with a glow. It is deleted, + along with the unreferenced `branding/Architecture.png`, which showed a third wordmark and an + ADK sidecar, a vector-store memory layer, eval datasets and LLM-as-judge. The architecture + picture is now only the Mermaid diagram, which is held to the same facts as the prose. +- **The badges were six identical violet pills, and the diagram was five pastel fills.** The + accent spent on everything is the accent spent on nothing, so the stack badges now carry each + tool's own colour over the shared Ink label, and the violet is kept for the two that are ours + (version, licence). The architecture diagram rendered as a bright light-mode block in the + middle of a dark-branded README; it is now Panel fills with Fog text, where only the border + carries meaning — the accent on the kernel, the code teal on the adapters. A Mermaid `init` + block sets the edge-label, cluster and line colours, which previously defaulted to light chips + and near-invisible arrows on a dark canvas. Checked by rendering it on both GitHub canvas + colours, which is also how the cluster titles were found to be colliding with their own nodes. - **The project had two visual identities and no way to tell which was current.** `branding/` carried a logo set that nothing in the tree referenced by the same name the README used, the docs site was Material's stock teal with fonts fetched from Google, and Studio's tab icon was a