Uh oh!
There was an error while loading. Please reload this page.
docs: fix sidebar overflow at mid-width viewports and add a favicon - #2426
Conversation
|
@modelcontextprotocol/client@modelcontextprotocol/codemod@modelcontextprotocol/core@modelcontextprotocol/server@modelcontextprotocol/server-legacy@modelcontextprotocol/express@modelcontextprotocol/fastify@modelcontextprotocol/hono@modelcontextprotocol/nodecommit: |
The --vp-layout-max-width: 1680px override interacts badly with the default theme's (min-width: 1440px) rules, which assume the layout max width never exceeds 1440px: on viewports between 1440px and 1680px their calc() goes negative, collapsing the sidebar and spilling the nav title over the search bar. Clamp the override to the viewport (min(100vw, 1680px)) so those rules resolve to their stock values on narrower viewports. Also add the MCP logo favicon (the same asset the Python SDK docs use) to both the v2 and v1 sites. The v1 site's content/ is build-generated, so build-docs-site.sh copies the shared asset into its public dir.
9b2c3ad to
79dd7d4CompareThere was a problem hiding this comment.
LGTM — docs-site-only change (CSS layout clamp, favicon asset, head links, build-script copy); no SDK runtime code touched.
Extended reasoning...
Overview
This PR is confined to the documentation site: a CSS variable clamp in docs/.vitepress/theme/custom.css (--vp-layout-max-width: min(100vw, 1680px)), a new docs/public/favicon.svg asset, head link entries in the v2 and v1 VitePress configs, and a small addition to scripts/build-docs-site.sh to copy the shared favicon into the generated v1 content/public/ directory. No package source, protocol, transport, or type code is modified.
Security risks
None. The changes are static-site presentation and build-copy steps. The SVG is a plain vector logo (paths and a mask, no scripts or external references), and the head links point to same-site paths. The build script addition is a straightforward mkdir -p + cp of a repo-local file into a build-generated directory.
Level of scrutiny
Low. This is a docs/build-tooling change with no effect on the published SDK packages or any security-sensitive path. The riskiest piece is the CSS clamp, whose worst failure mode is a cosmetic layout regression on the docs site; the PR description reports manual measurement across viewport widths for both sites. The v2 head href is spelled with the /v2/ prefix explicitly (VitePress does not base-prefix head hrefs), and the v1 config's /favicon.svg matches the file the build script copies into content/public/, so the two halves are consistent.
Other factors
The bug hunting system found no issues, and there are no prior reviewer comments on the timeline. The change is small, self-contained, and matches the repo's minimalism principle since it adds no API surface.
Uh oh!
There was an error while loading. Please reload this page.
Two fixes for the docs site:
Sidebar overflow at mid-width viewports. The theme overrides
--vp-layout-max-widthto 1680px, but the default theme's(min-width: 1440px)rules size the sidebar and nav title ascalc((100% - (var(--vp-layout-max-width) - 64px)) / 2 + ...), which assumes the max width never exceeds 1440px. On viewports between 1440px and 1680px that calc goes negative: the sidebar column collapses (~175px at a 1500px window) and the site title spills out over the search bar. Clamping the override tomin(100vw, 1680px)makes those rules resolve to their stock sub-1440px values on narrower viewports while keeping the wide layout above 1680px. Measured after the fix: no title overflow at any width from 960px up (including the longer v1 title), and the doc column reaches its 960px cap from ~1680px viewports instead of ~1900px.Favicon. Adds the MCP logo favicon, the same asset the Python SDK docs just added, to both the v2 and v1 sites. The v1 site's
content/is generated at build time, sobuild-docs-site.shcopies the shareddocs/public/favicon.svginto its public dir. Ran the full combinedbuild-docs-site.shlocally: both site roots serve the icon and both pages carry the head link.AI Disclaimer