Skip to content

docs: Furo theme + TCRi branding (docs site + README logo) - #26

Merged
nceglia merged 2 commits into
mainfrom
docs/furo-aesthetic
Jun 8, 2026
Merged

docs: Furo theme + TCRi branding (docs site + README logo)#26
nceglia merged 2 commits into
mainfrom
docs/furo-aesthetic

Conversation

@nceglia

@nceglia nceglia commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Minimal white aesthetic + brand identity for the docs, per request.

What changed

  • Theme → Furo: minimal, white-background, modern sidebar (replaces sphinx-rtd-theme).
  • Sidebar logo: the framework.png schematic (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.png stays as the home-page figure.
  • Favicon: the green node/receptor "mark".
  • Palette: white background · bold near-black headings · dark-grey body · brand green #39de2d as 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-themefuro.

Verification (screenshots, light + dark)

Built locally with the deps mocked and previewed both color schemes:

  • Light — white bg, bold black headings with green underline rules, green links, logo crisp on white.
  • Dark — readable (headings inherit the theme foreground), white wordmark logo, green accents preserved.
  • API reference (TCRIModel) renders the real __init__(adata, n_latent=128, …) signature with the green accent border (preview_inspect confirmed rgb(57,222,45)).

custom.css is mode-safe — it only sets the green accents and weights, never a fixed fg/bg color.

Notes

🤖 Generated with Claude Code

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
nceglia marked this pull request as ready for review June 8, 2026 03:33
@nceglia
nceglia changed the base branch from docs/d6-readthedocs-build to main June 8, 2026 03:39
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>
@nceglia nceglia changed the title docs: Furo theme + TCRi branding (minimal white + green) docs: Furo theme + TCRi branding (docs site + README logo) Jun 8, 2026
@nceglia

nceglia commented Jun 8, 2026

Copy link
Copy Markdown
Owner Author

Folded in the README logo update: swapped the older framed grey logo for the updated tight wordmark (tcri_logo_tight_1024.png — same clean mark now used in the docs sidebar) and reduced the display width 500 → 400. Base was retargeted to main (D6 / #25 is merged); PR is mergeable.

@nceglia
nceglia merged commit 1b94d9b into main Jun 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant