Skip to content

Commit 7e73dbb

Browse files
committed
docs(development): record the Discussion TrakHound#184 house-style answers
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.
1 parent 0d25928 commit 7e73dbb

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ export default withMermaid(
253253
text: 'Repository development',
254254
items: [
255255
{ text: 'Documentation site', link: '/development/docs-site' },
256+
{ text: 'Docs-site house style', link: '/development/house-style' },
256257
{ text: 'Release builder', link: '/development/builder' },
257258
],
258259
},

docs/development/house-style.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Docs-site house style
2+
3+
This page records the documentation-site visual choices the maintainer signed off on. Each row cites the GitHub discussion thread the answer came from so a future contributor can see who decided what, when, and why. Treat this page as the canonical answer when a new docs PR proposes a brand, palette, typography, or social-share change — match what shipped, or open a new discussion to revise it.
4+
5+
The source of record for the current set is [Discussion #184](https://github.com/TrakHound/MTConnect.NET/discussions/184), maintainer reply dated 2026-06-01.
6+
7+
## What shipped
8+
9+
| Surface | Answer | Source |
10+
| --- | --- | --- |
11+
| Logo | `docs/img/mtconnect-net-03-md.png`, copied into `docs/public/logo.png` and wired through `themeConfig.logo`. The asset already carries the `mtconnect .NET` wordmark, so `themeConfig.siteTitle` is hidden to avoid the wordmark rendering twice in the top nav. | Discussion #184 |
12+
| Accent color | `#0073e6` — the TrakHound brand accent. Overrides `--vp-c-brand-1`, `--vp-c-brand-2`, `--vp-c-brand-3`, and `--vp-c-brand-soft` for both light (`:root`) and dark (`.dark`) modes. Implementation lives in `docs/.vitepress/theme/style.css`. | Discussion #184 |
13+
| Typography | VitePress default. The maintainer expressed no strong preference, so no font-family override is applied. | Discussion #184 |
14+
| Hero block | A third call-to-action — `Download latest release` — links to `https://github.com/TrakHound/MTConnect.NET/releases/latest`. Sits between `Get started` and `View on GitHub`. | Discussion #184 |
15+
| Code-block syntax theme | VitePress default. Kept per the maintainer's preference. | Discussion #184 |
16+
| Favicon | `<link rel="icon" type="image/png" href="/logo.png">`. Same asset as the hero logo. | Discussion #184 |
17+
| Social-share preview | Open Graph (`og:type`, `og:title`, `og:description`, `og:image`) and Twitter Card (`twitter:card=summary_large_image`, `twitter:title`, `twitter:description`, `twitter:image`) meta tags in `head[]`. `og:image` and `twitter:image` both point at `/logo.png`. | Discussion #184 |
18+
| `theme-color` | `#0073e6` — updated from the previous `#1f6feb` to match the new brand accent. Drives mobile browser chrome color. | Bonus alignment with the accent change, not separately requested in #184. |
19+
| Google Analytics | Out of scope. The maintainer is wiring analytics on the deploy side; no GA `<script>` tag is added to the source. | Discussion #184 |
20+
21+
## File map
22+
23+
| Surface | File |
24+
| --- | --- |
25+
| Logo asset | `docs/public/logo.png` |
26+
| Brand-palette CSS override | `docs/.vitepress/theme/style.css` |
27+
| Theme entry that loads the override | `docs/.vitepress/theme/index.ts` |
28+
| Favicon + OG / Twitter meta + `theme-color` | `docs/.vitepress/config.ts` (`head[]`) |
29+
| `themeConfig.logo` + `themeConfig.siteTitle: false` | `docs/.vitepress/config.ts` (`themeConfig`) |
30+
| Hero `Download latest release` CTA | `docs/index.md` (front-matter `hero.actions`) |
31+
32+
## Changing any of this
33+
34+
The list above is a maintainer decision, not a contributor preference. Before opening a PR that revises an entry — re-skinning the palette, replacing the logo, switching the syntax theme, adding analytics — open a discussion that proposes the change and tag the maintainer. Link the resulting answer here once it merges, replacing the row that changed.
35+
36+
## See also
37+
38+
- [Documentation site](/development/docs-site) — how the site is built and how `DOCS_BASE` works.
39+
- [Discussion #184](https://github.com/TrakHound/MTConnect.NET/discussions/184) — the source-of-record thread for the current answers.

0 commit comments

Comments
 (0)