docs: Furo theme + TCRi branding (docs site + README logo) - #26
Merged
Conversation
Replace the Read the Docs theme with Furo for a minimal, white-background look and adopt the TCRi brand identity: - Sidebar logo: the framework.png schematic (previously html_logo, looked off) is replaced by the tcri wordmark, with light + dark SVG variants; the text title is hidden since the wordmark IS the title. framework.png stays as the home-page figure. - Favicon: the green node/receptor "mark" (favicon_mark.ico). - Palette: white background, bold near-black headings, dark-grey body, and the brand green #39de2d as a strong accent (heading rules, API-signature bars, active nav). Body link text uses a darkened green (#1f9e16) that stays readable on white; dark mode uses the brighter #39de2d. - requirements.txt: sphinx-rtd-theme -> furo. custom.css is mode-safe (no fixed foreground/background colors), so both light and dark render cleanly. Verified locally in both modes; the API reference signatures (e.g. TCRIModel) carry the green accent border, and the real constructor signature renders under the deps-mocked build. Stacked on the D6 ReadTheDocs config (#25). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
nceglia
marked this pull request as ready for review
June 8, 2026 03:33
Replace the older framed grey logo with the current brand wordmark (tcri_logo_tight_1024.png — clean black "tcr" + green plate-i, transparent, tightly cropped) and reduce the display width 500 -> 400 to compensate for the tighter crop. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Owner
Author
|
Folded in the README logo update: swapped the older framed grey logo for the updated tight wordmark ( |
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.
Minimal white aesthetic + brand identity for the docs, per request.
What changed
framework.pngschematic (which looked off as the logo) → the tcri wordmark, with light + dark SVG variants. The text title is hidden since the wordmark is the title.framework.pngstays as the home-page figure.#39de2das a strong accent (heading rules, API-signature bars, active nav). Body links use a darkened green (#1f9e16) for readable contrast on white; dark mode uses the brighter#39de2d.docs/requirements.txt:sphinx-rtd-theme→furo.Verification (screenshots, light + dark)
Built locally with the deps mocked and previewed both color schemes:
TCRIModel) renders the real__init__(adata, n_latent=128, …)signature with the green accent border (preview_inspectconfirmedrgb(57,222,45)).custom.cssis mode-safe — it only sets the green accents and weights, never a fixed fg/bg color.Notes
docs/d6-readthedocs-build; merge docs: make ReadTheDocs build deps-free and reliable (D6) #25 first, then this (GitHub will retarget the base tomainon docs: make ReadTheDocs build deps-free and reliable (D6) #25's merge).🤖 Generated with Claude Code