docs: PR #473 review fixes + local DESIGN.md adoption record#474
Merged
docs: PR #473 review fixes + local DESIGN.md adoption record#474
Conversation
Fixes the issues surfaced in the post-merge code review of the txn2 re-skin. - Scope every homepage component class under .page--home (.hero__*, .section, .section__*, .flagship*, .terminal*, .stack*, .coda*, .ticker*, .dropcap, .outline). Without scoping, any inner-page markdown using class="terminal" or class="section" inherited homepage display styling. - Rename .footer (and __rule, __inner, __col, __label, __text, __links, __mono, __base) to .home-footer to remove the global collision risk and the dead .page--home + .footer adjacent-sibling selector. - Lower body::before / body::after (grain, vignette) from z-index 100 to z-index 1 so the rail (z 50) and skiplink (z 200) are no longer darkened by the vignette. - Add @supports not selector(:has(*)) fallback so headings with inline code still get mono+signal treatment on Firefox <121 / Safari <15.4. - Guard the rail/footer UTC-clock IIFE with window.__kubefwdClock so Material's navigation.instant rehydration does not register a fresh setInterval handle on each navigation. - Add Mermaid theming via Material's --md-mermaid-* CSS variables plus a .md-typeset .mermaid container restyle so the architecture diagrams render with the dark palette.
Thin local sidecar to the canonical txn2/www DESIGN.md and tokens.json. Records what is project-specific without duplicating the upstream visual identity rules. Captures MkDocs Material learnings that do not apply to the upstream Hugo site, so the next sister project can adopt the design system without re-discovering them. Sections: canonical reference table, adoption level (token alignment), file map, project-specific components (kubefwd flagship variants, terminal usage, stack list anchored to docs sections), 12 numbered MkDocs Material learnings, voice / copy rules deferred to upstream, update workflow, and a downstream contract for sister projects (txeh, mcp-s3, mcp-trino, mcp-datahub, mcp-data-platform) that want to reuse this file as a template.
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.
Follow-up to #473. Two commits.
Summary
132e0bf— Address PR #473 review findingsPost-merge code review surfaced six issues. All addressed.
.hero__*,.section,.section__*,.flagship*,.terminal*,.stack*,.coda*,.ticker*,.dropcap,.outline) now requires.page--homeas an ancestor selector. Without scoping, any inner-page markdown usingclass="terminal"orclass="section"would inherit homepage display styling..footer(and all__rule,__inner,__col,__label,__text,__links,__mono,__basesiblings) to.home-footer. Dropped the dead.page--home + .footeradjacent-sibling selector that never matched in the actual DOM nesting.body::before(grain) andbody::after(vignette) fromz-index: 100toz-index: 1so the rail (z 50) and skiplink (z 200) are no longer darkened by the vignette.:has()fallback. Added@supports not selector(:has(*))block so headings containing inline code still render with mono+signal on Firefox <121 and Safari <15.4 (less ideal, but readable).setIntervalleak undernavigation.instant. Wrapped the live UTC clock IIFE withwindow.__kubefwdClockglobal guard. Each return to the homepage via instant-nav now reuses the existing handle and refreshes the displayed time without registering a new interval.--md-mermaid-*CSS variables to the slate scheme block and a.md-typeset .mermaidcontainer restyle. Architecture and MCP integration diagrams now render with the txn2 dark palette.4a14b8f— Add local DESIGN.md adoption recordThin local sidecar to canonical
txn2/www/DESIGN.mdandtokens.json. References upstream as the source of truth for tokens, typography, components, and voice. Records only what is project-specific and the MkDocs Material learnings that do not apply to the upstream Hugo site.Sections:
font: false, scoping discipline, footer rename, technical h3/h4 typography, tabbed-set restyle, Mermaid via CSS vars,setIntervalguard, dark-only palette, overlay z-index, what Hugo can do that MkDocs cannotFiles
Test plan