feat(docs): apply maintainer house style to the VitePress docs site#186
Merged
Merged
Conversation
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
The doc-comments commit on MTConnect-Compliance-Tests shifted the line of the FixtureDirEnv read in CppAgentParityWorkflowTests.cs from 488 to 499. The generated page embeds source line numbers, so the change desynced docs/reference/environment-variables.md and the in-sync test in MTConnect.NET-Docs-Tests failed on every integration branch layered on top of this PR (TrakHound#185, TrakHound#186).
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
The doc-comments commit on MTConnect-Compliance-Tests shifted the line of the FixtureDirEnv read in CppAgentParityWorkflowTests.cs from 488 to 499. The generated page embeds source line numbers, so the change desynced docs/reference/environment-variables.md and the in-sync test in MTConnect.NET-Docs-Tests failed on every integration branch layered on top of this PR (TrakHound#185, TrakHound#186).
ottobolyos
force-pushed
the
feat/docs-ui-style
branch
from
06b260a to
4e6e542
Compare
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
…swers PR TrakHound#186 implements the maintainer's docs-site house-style choices from Discussion TrakHound#184. Without a ledger page, a future contributor proposing a palette / logo / typography change has no canonical place to look up which choices the maintainer signed off on. Add `docs/development/house-style.md` with one row per surface (logo, accent color, typography, hero block, syntax theme, favicon, social- share preview, theme-color meta, Google Analytics), citing Discussion TrakHound#184 as the source of record. Wire the page into the `/development/` sidebar between 'Documentation site' and 'Release builder' so it sits alongside the existing build-side docs.
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
PR TrakHound#186 wires the maintainer-confirmed house-style choices from Discussion TrakHound#184 — the brand logo, the #0073e6 accent color, the favicon, the OG / Twitter Card meta block, and the 'Download latest release' hero CTA — but nothing on the test side asserts those surfaces survive a future theme refactor. Add `Landing_Page_Carries_The_House_Style_Surfaces` to the existing RouteCheckTests Playwright fixture. The test navigates the homepage, extracts the theme-color meta, favicon href + type, og:title + og:image, twitter:card + twitter:image, the nav <img> rendered by themeConfig.logo, and the hero CTA href, then pins each one against its expected value. The favicon path is also fetched over HTTP so a stale href that 404s is caught — the meta-tag presence check alone would not surface that. The test reuses the fixture's preview server and browser context, so the only cost is one extra navigation in the existing Category=E2E leg. Failure messages name the missing surface directly rather than forcing the reader into a snapshot diff.
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
…swers PR TrakHound#186 implements the maintainer's docs-site house-style choices from Discussion TrakHound#184. Without a ledger page, a future contributor proposing a palette / logo / typography change has no canonical place to look up which choices the maintainer signed off on. Add `docs/development/house-style.md` with one row per surface (logo, accent color, typography, hero block, syntax theme, favicon, social- share preview, theme-color meta, Google Analytics), citing Discussion TrakHound#184 as the source of record. Wire the page into the `/development/` sidebar between 'Documentation site' and 'Release builder' so it sits alongside the existing build-side docs.
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 2, 2026
PR TrakHound#186 wires the maintainer-confirmed house-style choices from Discussion TrakHound#184 — the brand logo, the #0073e6 accent color, the favicon, the OG / Twitter Card meta block, and the 'Download latest release' hero CTA — but nothing on the test side asserts those surfaces survive a future theme refactor. Add `Landing_Page_Carries_The_House_Style_Surfaces` to the existing RouteCheckTests Playwright fixture. The test navigates the homepage, extracts the theme-color meta, favicon href + type, og:title + og:image, twitter:card + twitter:image, the nav <img> rendered by themeConfig.logo, and the hero CTA href, then pins each one against its expected value. The favicon path is also fetched over HTTP so a stale href that 404s is caught — the meta-tag presence check alone would not surface that. The test reuses the fixture's preview server and browser context, so the only cost is one extra navigation in the existing Category=E2E leg. Failure messages name the missing surface directly rather than forcing the reader into a snapshot diff.
ottobolyos
force-pushed
the
feat/docs-ui-style
branch
from
4ffde0e to
7aa25d1
Compare
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 3, 2026
…swers PR TrakHound#186 implements the maintainer's docs-site house-style choices from Discussion TrakHound#184. Without a ledger page, a future contributor proposing a palette / logo / typography change has no canonical place to look up which choices the maintainer signed off on. Add `docs/development/house-style.md` with one row per surface (logo, accent color, typography, hero block, syntax theme, favicon, social- share preview, theme-color meta, Google Analytics), citing Discussion TrakHound#184 as the source of record. Wire the page into the `/development/` sidebar between 'Documentation site' and 'Release builder' so it sits alongside the existing build-side docs.
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 3, 2026
PR TrakHound#186 wires the maintainer-confirmed house-style choices from Discussion TrakHound#184 — the brand logo, the #0073e6 accent color, the favicon, the OG / Twitter Card meta block, and the 'Download latest release' hero CTA — but nothing on the test side asserts those surfaces survive a future theme refactor. Add `Landing_Page_Carries_The_House_Style_Surfaces` to the existing RouteCheckTests Playwright fixture. The test navigates the homepage, extracts the theme-color meta, favicon href + type, og:title + og:image, twitter:card + twitter:image, the nav <img> rendered by themeConfig.logo, and the hero CTA href, then pins each one against its expected value. The favicon path is also fetched over HTTP so a stale href that 404s is caught — the meta-tag presence check alone would not surface that. The test reuses the fixture's preview server and browser context, so the only cost is one extra navigation in the existing Category=E2E leg. Failure messages name the missing surface directly rather than forcing the reader into a snapshot diff.
ottobolyos
force-pushed
the
feat/docs-ui-style
branch
from
b580b37 to
dc30a60
Compare
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 3, 2026
The CSS-variable comment named the maintainer-supplied brand value 'colour' (British spelling), which is inconsistent with the AmE register used throughout the committed source. The value itself (`#0073e6`) was already AmE-correct; only the comment wording is adjusted here. No behavioural change.
…swers PR TrakHound#186 implements the maintainer's docs-site house-style choices from Discussion TrakHound#184. Without a ledger page, a future contributor proposing a palette / logo / typography change has no canonical place to look up which choices the maintainer signed off on. Add `docs/development/house-style.md` with one row per surface (logo, accent color, typography, hero block, syntax theme, favicon, social- share preview, theme-color meta, Google Analytics), citing Discussion TrakHound#184 as the source of record. Wire the page into the `/development/` sidebar between 'Documentation site' and 'Release builder' so it sits alongside the existing build-side docs.
PR TrakHound#186 wires the maintainer-confirmed house-style choices from Discussion TrakHound#184 — the brand logo, the #0073e6 accent color, the favicon, the OG / Twitter Card meta block, and the 'Download latest release' hero CTA — but nothing on the test side asserts those surfaces survive a future theme refactor. Add `Landing_Page_Carries_The_House_Style_Surfaces` to the existing RouteCheckTests Playwright fixture. The test navigates the homepage, extracts the theme-color meta, favicon href + type, og:title + og:image, twitter:card + twitter:image, the nav <img> rendered by themeConfig.logo, and the hero CTA href, then pins each one against its expected value. The favicon path is also fetched over HTTP so a stale href that 404s is caught — the meta-tag presence check alone would not surface that. The test reuses the fixture's preview server and browser context, so the only cost is one extra navigation in the existing Category=E2E leg. Failure messages name the missing surface directly rather than forcing the reader into a snapshot diff.
ottobolyos
force-pushed
the
feat/docs-ui-style
branch
from
dc30a60 to
34e6bba
Compare
PatrickRitchie
approved these changes
Jun 3, 2026
github-project-automation
Bot
moved this from In Progress
to Done
in MTConnect.NET-Development
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 3, 2026
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 3, 2026
ottobolyos
added a commit
to ottobolyos/mtconnect.net
that referenced
this pull request
Jun 3, 2026
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
2 participants
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.
Summary
This PR lands the docs-site house-style choices @PatrickRitchie confirmed in #184:
docs/img/mtconnect-net-03-md.png) is copied intodocs/public/and wired throughthemeConfig.logo. The image already carries the 'mtconnect .NET' wordmark, sothemeConfig.siteTitleis hidden to avoid the wordmark rendering twice in the top nav.--vp-c-brand-1resolves to#0073e6, the TrakHound accent. Light and dark variants are generated from the same hue./logo.pngso social previews render correctly.theme-colormeta tag is updated from#1f6febto#0073e6so mobile browser chrome matches the new brand color.Typography and the code-block syntax theme are unchanged, per the maintainer's preference. Google Analytics is out of scope -- the maintainer is wiring that himself.
Files changed
docs/public/logo.png-- copied fromdocs/img/mtconnect-net-03-md.png.docs/.vitepress/config.ts--logo,siteTitle: false, favicon link, Open Graph / Twitter Card meta,theme-colorupdated to#0073e6.docs/.vitepress/theme/index.ts-- theme entry that extends the default theme and loads the brand-palette override.docs/.vitepress/theme/style.css--#0073e6brand-palette override, with per-mode shades for light and dark.docs/index.md-- adds the 'Download latest release' hero action.docs/development/house-style.md-- records the house-style decisions from Discussion Docs site UI style—logo, color palette, type scale: what house style should the site adopt? #184 (typography, code-block theme, analytics scope).tests/MTConnect.NET-Docs-Tests/RouteCheckTests.cs-- extends the docs route-check suite with assertions covering the landing-page hero surfaces introduced by this PR (logo, CTA wording, brand-color meta, Open Graph tags).Verification
npm run build(vitepress build) is green; the generated HTML carries#0073e6in the CSS bundle,/logo.pngin the<link rel="icon">,og:image/twitter:imagepointing at/logo.png, andtheme-color="#0073e6".dotnet buildis green;dotnet test(docs-tests project) is green on the extendedRouteCheckTestssuite.Closes #184.