Repository navigation
docs(readme): colour the badges, rebrand the diagram, delete the fabricated hero - #84
Open
harshuljain13 wants to merge 1 commit into
Open
harshuljain13 wants to merge 1 commit into
harshuljain13 wants to merge 1 commit into
Conversation
β¦icated hero Three visual problems, one of them a correctness problem wearing visual clothes. The six badges were all #A685EE. Uniform accent is not restraint, it is the accent spent on everything, which is the same as spending it on nothing β the row read as one violet smear. The stack badges now carry each tool's own recognisable colour (Python blue, LangChain, MCP, OTel) over the shared Ink label that holds the row together, and the violet is kept for the two that are actually ours: the version and the licence. The architecture diagram was five pastel fills β amber, mint, green, slate, blue β so a dark-branded README had a bright light-mode block dropped in the middle of it. Every node is now Panel with Fog text and only the border carries meaning: the accent on the kernel, which is what the diagram argues for, the code teal on the adapters, dim on what we consume. Mermaid's defaults needed an init block too: edge labels were rendering as light chips and the arrows were nearly invisible against a dark canvas. And `branding/hero/image.png`, directly under "The problem", showed Google ADK, OpenAI SDK and CrewAI as engines with Memory and Guardrails as components. The same README says a few sections later that none of those are built. It is the exact over-claiming the conformance grid exists to prevent, in the first picture a visitor sees, carrying the pre-rebuild wordmark with a glow. Deleted, with no replacement needed: the Mermaid diagram immediately below already does that job and is held to the same facts as the prose. `branding/Architecture.png` went with it β unreferenced, a third wordmark, and an ADK sidecar, vector-store memory layer, eval datasets and LLM-as-judge. Verified by rendering rather than reading. Every badge URL fetched: all six return SVG, five with the logo actually embedded, so no slug silently dropped its icon. The diagram was rendered with mmdc on both GitHub canvas colours (#0d1117 and #ffffff) β which is how the cluster titles turned out to be colliding with the nodes inside them, fixed by shortening them, and how the light-chip edge labels were caught.
This branch has not been deployed
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.
What changed, and why
Three visual problems β one of them a correctness problem wearing visual clothes.
The badges were six identical violet pills
All six were
#A685EE. Uniform accent is not restraint; it is the accent spent on everything, which is the same as spending it on nothing β the row read as one violet smear. The stack badges now carry each tool's own recognisable colour over the shared Ink label that holds the row together, and the violet is kept for the two that are actually ours:#A685EEviolet β ours#3776AB#1C3C3C#D97757#425CC7#A685EEviolet β ourslabelColor=0D1317throughout, so the left half of every pill is Ink.The diagram was a light-mode block in a dark README
The Mermaid architecture diagram used five pastel fills β pale amber, mint, green, slate, blue β with nothing to do with the brand. Every node is now Panel
#141C22with Fog text, and only the border carries meaning: the accent on the kernel (which is what the diagram argues for), the code teal on the adapters, dim on what we consume and never reimplement.Mermaid's own defaults needed fixing too, via an
initblock: edge labels were rendering as light chips and the arrows were nearly invisible on a dark canvas.The hero image advertised four things we cannot do
This is the one that matters.
branding/hero/image.pngsat directly under The problem β the first picture a visitor sees β and showed Google ADK, OpenAI SDK and CrewAI as engines, with Memory and Guardrails as components. The same README states a few sections later that none of those are built. It also carried the pre-rebuild wordmark, with a glow.That is precisely the over-claiming
agentship verifyexists to prevent, and the same defect #63 raised against the website β except in the framework's own README. Deleted, and nothing replaces it: the Mermaid diagram immediately below already does that job and is held to the same facts as the prose.branding/Architecture.pngwent with it β unreferenced by anything, a third wordmark variant, and depicting an ADK sidecar, a vector-store memory layer, eval datasets and LLM-as-judge.How it was verified
By rendering, not by reading the diff.
<imagepresent), so no logo slug silently dropped its icon βmodelcontextprotocolandpypiboth resolve. The sixth requests no logo.mmdcon both GitHub canvas colours,#0d1117and#ffffff. That is how two defects were caught that reading the source would not have shown: the cluster titles were colliding with the nodes inside them (long labels wrap and overlap β fixed by shortening them), and the edge labels were light chips. Both themes now read correctly; the diagram is a dark card on white in light mode, which is the kit's dark-first intent.Gate, on exit code:
make test0(950 passed, 26 skipped, 3 xfailed),ruff check .0,ruff format --check .0,mkdocs build --strict0,agentship verify --agents-dir examples0.Checklist
make testpasses locally.ruff checkandruff format --checkare clean.agentship verifystill exits0, with no new over-claims.docs/capabilities/. β none; this is the README and two deleted assets.docs/CHANGELOG.mdhas an entry under## [Unreleased].docs/decisions/. β none; the badge and palette reasoning is in comments beside the markup.Anything deliberately left undone
tokens/, but a second architecture picture has to be kept in step with the Mermaid one, and the drift between those two is exactly what produced the deleted file. Noted inbranding/README.mdfor whoever wants one later.adkrepo topic and the About text still say ADK and MIT. Settings-only, so I cannot touch them; flagged previously and still outstanding. The About text contradicts GitHub's ownApache-2.0licence detection on the same page.