Skip to content

Docs(logo): Use MCP artwork throughout Sphinx - #134

Merged
tony merged 3 commits into
mainfrom
logo-static
Sep 27, 2026
Merged

tony merged 3 commits into
mainfrom
logo-static

Conversation

@tony

@tony tony commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Use the Python MCP mark throughout the Sphinx site and package README. The sidebar continues to read docs/_static/img/libtmux.svg, and the favicon and all eight existing manifest icon sizes are replaced in place. Additional PNG sizes, Apple and maskable icons, a Safari mask, and social cards live beside them under docs/_static/.

The Sphinx template links the manifest and browser icons. Open Graph uses the 1200 × 630 MCP card; Twitter uses the 1200 × 600 card. The repository social preview uses the MCP artwork too.

Validation

  • Sphinx dirhtml build with -E -a -W --keep-going, into a newly created empty output directory.
  • Rendered audit: 102 sidebar pages, 99 content pages with Open Graph images, 102 Twitter images, and all ten manifest entries resolve. Sphinx's search and two index pages retain their existing lack of OG tags.
  • All ten original branding images are replaced; 24 kit assets match the generated output byte for byte. ICO includes 16, 32, 48, and 256px sizes.
  • Chromium, Firefox, and WebKit render the 200px sidebar logo in both themes.
  • uv build: wheel README URL and sdist static assets checked.
  • Ruff checks and git diff --check pass.

Replaces #133 after its merge was removed from main at the maintainer's request. The final tree uses the existing Sphinx asset paths throughout.

why: Give the MCP server its language and product identity.

what:
- Add the SVG, PNG fallback and cog repository social card.
- Include local artwork in source distributions.
why: Sphinx reads the existing docs/_static paths for its sidebar and
favicon. The browser icons and social cards must use the same MCP mark.

what:
- Replace the sidebar SVG, favicon, and every existing manifest icon
- Keep the README fallback and extra browser sizes under docs/_static
- Add maskable, Apple, Safari, Open Graph, and Twitter artwork
- Link the manifest and social images from the Sphinx page template

Verified with a fresh Sphinx -E -a build and all generated asset links.
Chromium, Firefox, and WebKit render both themes. Wheel metadata and
sdist artwork match the source assets.
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.84%. Comparing base (cefb3d6) to head (e655196).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #134   +/-   ##
=======================================
  Coverage   86.84%   86.84%           
=======================================
  Files          46       46           
  Lines        3899     3899           
  Branches      587      587           
=======================================
  Hits         3386     3386           
  Misses        359      359           
  Partials      154      154           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tony
tony merged commit 8207525 into main Sep 27, 2026
9 checks passed
tony added a commit that referenced this pull request Sep 27, 2026
why: Sphinx needs the MCP mark at its existing docs asset paths, and
browser icons and link previews should identify the same application.

what:
- Replace the sidebar logo, favicon, and all existing manifest icons
- Add browser, mobile, Open Graph, and Twitter artwork
  under docs/_static
- Link the manifest and social cards from the Sphinx template
- Reuse the MCP PNG in the README and repository social preview

Verified with a clean Sphinx build, generated-link and package audits,
and Chromium, Firefox, and WebKit in light and dark themes. All six
Python/tmux CI cells pass at the merged PR head.
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.

2 participants