Repository navigation
chore(branding): apply the brand kit to the repo, docs site and Studio - #80
Merged
Merged
Conversation
8 tasks done
harshuljain13
force-pushed
the
chore/apply-brand-kit
branch
from
October 14, 2026 10:56
88771ac to
360b985
Compare
The project had two visual identities and nothing said which was current. `branding/` carried a logo set from before the rebuild, the README pointed at `branding/banners/github-readme-banner@3x.png`, the docs site was Material's stock teal with its fonts fetched from Google on every page load, and Studio's tab icon was a placeholder: a blue circle with a white triangle in it. Anyone reaching for "the logo" had to guess. The AgentShip brand kit is now vendored under `branding/` — logo, banner, fonts and tokens — and the superseded `logos/`, `icons/`, `favicons/` and `banners/` directories are deleted, so there is no second identity left to pick up by mistake. `branding/README.md` records which file belongs where, the clearspace and accent rules, and the licensing. The docs site serves the mark, the favicon, the brand palette and self-hosted Bricolage Grotesque / Instrument Sans / JetBrains Mono, with `font: false` so Material does not also pull its own — the built HTML now makes no request to Google. The kit ships a dark scheme only; this site deliberately keeps a reader-preference toggle, so the light half is filled in from the kit's documented light tokens, where the accent becomes `#6A47C2` because `#A685EE` does not carry enough contrast as text on a light ground. Studio's palette maps onto the kit's six greys in order and it draws the real mark rather than the placeholder. It stays a single no-build file, so it carries the token values inline instead of importing `tokens/tokens.css`. `/docs` and `/redoc` are rebuilt by hand for one reason: both hard-code FastAPI's own favicon, so a tab of AgentShip API documentation was branded as somebody else's project. Same URLs, same Swagger and ReDoc assets, served against a new public `GET /favicon.svg`. Two documentation claims were wrong and are fixed here because the branding pass is what surfaced them. The README listed voice under "not built yet" in one paragraph and as shipped in another — voice has been released since `0.0.3`. Its Status section, and the top of `docs/RELEASING.md`, told readers to pin `agentship-sdk==0.0.2` as "the latest on PyPI" and said the next release would be `0.0.3`; anyone following either would have pinned two releases behind. The fonts are not ours. They are redistributed under the SIL Open Font License 1.1 with each licence file kept beside them, as the OFL requires, and the README now notes that Apache 2.0 grants no rights in the AgentShip name or logo.
harshuljain13
force-pushed
the
chore/apply-brand-kit
branch
from
October 15, 2026 09:01
360b985 to
3679c51
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.
What changed, and why
The project had two visual identities and nothing said which was current.
branding/carried a logo set from before the rebuild, the README pointed atbranding/banners/github-readme-banner@3x.png, the docs site was Material's stock teal with its fonts fetched from Google on every page load, and Studio's tab icon was a placeholder — a blue circle with a white triangle in it. Anyone reaching for "the logo" had to guess which directory held the real one.The AgentShip brand kit is now vendored under
branding/(logo, banner, fonts, tokens), and the supersededlogos/,icons/,favicons/andbanners/directories are deleted, so there is no second identity left to pick up by mistake.branding/README.mdrecords which file belongs where, the clearspace and accent rules, and the licensing.The docs site serves the mark, the favicon, the brand palette and self-hosted Bricolage Grotesque / Instrument Sans / JetBrains Mono, with
font: falseso Material does not also pull its own. The kit ships a dark scheme only; this site deliberately keeps a reader-preference toggle, so I filled in the light half from the kit's documented light tokens rather than dropping the toggle. In light mode the accent becomes#6A47C2—#A685EEmeasures 2.9:1 as text on Paper, under AA.Studio's palette maps onto the kit's six greys in order (Ink, Panel, Harbor, Line, Line-strong, Outline) and it draws the real mark. It stays a single no-build file, so it carries the token values inline rather than importing
tokens/tokens.css; there is a comment saying so, because that duplication is deliberate and would otherwise look like drift./docsand/redocare rebuilt by hand for one reason: both hard-code FastAPI's own favicon, so a tab of AgentShip API documentation was branded as somebody else's project. Same URLs, same Swagger and ReDoc assets, served against a new publicGET /favicon.svg.Two documentation claims were wrong, and the branding pass is what surfaced them:
0.0.3.docs/RELEASING.md, told readers to pinagentship-sdk==0.0.2as "the latest on PyPI" and said the next release would be0.0.3. Anyone following either would have pinned two releases behind.The fonts are not ours. They are redistributed under the SIL OFL 1.1 with each licence file kept beside them, as the OFL requires, and the README now notes that Apache 2.0 grants no rights in the AgentShip name or logo (section 6).
How it was verified
The gate, run bare and checked on exit code rather than output:
make test0— 950 passed, 26 skipped, 3 xfailedruff check .0ruff format --check .0— 333 filesmkdocs build --strict0agentship verify --agents-dir examples0— grid 11/11, 0 over-claimsBeyond the suite, what I actually drove:
TestClient./docs,/redoc,/favicon.svg,/studio,/openapi.jsonand/healthzall answer200(and/still307s)./favicon.svgreturnsimage/svg+xmlwithCache-Control: public, max-age=604800, and its body containsA685EE— it is the brand mark, not a stale file. Both doc pages contain/favicon.svgin their markup./studioand/favicon.svgare both absent from the OpenAPI schema, which is the propertytest_studio.pyalready guards for Studio.site/*.htmlreferencesassets/agentship-mark-on-dark.svg,assets/favicon.svg,stylesheets/agentship.cssandassets/fonts/fonts.css, andgrep -c "fonts.gstatic\|fonts.googleapis"returns 0 — the Google Fonts request is genuinely gone, not just overridden.grepacross the tree forbranding/logos,branding/icons,branding/faviconsandbranding/bannersreturns nothing, and both image paths the README uses resolve on disk.Checklist
make testpasses locally.ruff checkandruff format --checkare clean.agentship verifystill exits0, with no new over-claims.docs/capabilities/. — the new route isGET /favicon.svg, browser chrome rather than contract, and deliberately out of the schema. See below.docs/CHANGELOG.mdhas an entry under## [Unreleased]. — the section did not exist yet, since0.0.4was just cut; this PR adds it.docs/decisions/. — see below.Anything deliberately left undone
GET /favicon.svgis public and out of the schema, matching/studio's rationale: it is chrome, not contract, and the bytes are identical for every caller, so it carries no tenant data. It is added to_DEFAULT_PUBLIC_PATHS; a favicon that 401s renders as a broken icon on/docsand/studioalike. No test asserts the route yet — I drove it by hand, as above.branding/banner/github-social-preview.png); it cannot be set from code. And the kit flagged that the repo About text may still say MIT whileLICENSEand everypyproject.tomlsay Apache-2.0 — worth checking while you are in Settings.docs/RELEASING.mdstill uses0.0.3in its worked examples (git tag v0.0.3,git checkout -b hotfix/0.0.4 v0.0.3), which reads oddly now that the same file correctly says the next release is0.0.5. I fixed the factual status claim but did not rewrite a release procedure's examples as part of a branding PR — happy to do it separately.system-ui, exactly as it already did for Inter, rather than adding ~200 KB of woff2 to theagentship-servicewheel. That was a deliberate call; the alternative is a one-line change if you want it.