Add OpenWDL brand guidelines website#3
Merged
Conversation
Adds a static React (Vite + TypeScript) brand-guidelines site under `site/` that renders the existing `brand-guidelines.pdf` as a living, single-page web reference driven by a typed data module (`src/data/brand.ts`), so colors, type tokens, logo metadata, and grid scales have one source of truth. - Sections for logo construction, logo color usage with a live background-luminance preview, typography with copyable CSS tokens, the color palette with click-to-copy swatches, the dot-grid scales, and downloadable logo assets (per-asset and a client-side zip). - A dotted-grid hero backdrop that fades off the first screen, a sticky nav, and a dark theme built entirely on CSS design tokens. - ESLint with `eslint-plugin-jsdoc` enforcing documented exports, plus GitHub Actions workflows for lint/test and GitHub Pages deployment. Also renames `Guidelines.pdf` to `brand-guidelines.pdf` and ignores the local `docs/` working directory.
Adopts the CC BY 4.0 license from main and updates the site footer in `Footer.tsx` to match.
`actions/checkout` v4→v7, `actions/setup-node` v4→v6, `actions/upload-pages-artifact` v3→v5, and `actions/deploy-pages` v4→v5. Node bumped 20→22 since Node 20 reached end-of-life.
Replaces the hand-rolled `GitHubIcon` SVG component with `SiGithub` from `react-icons`, so iconography comes from a maintained set rather than inline path data.
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
1 participant
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.
Turned the existing
brand-guidelines.pdfinto a living, single-page web reference for the OpenWDL brand, built as a static React (Vite + TypeScript) site undersite/. Everything renders from one typed data module (src/data/brand.ts), so the palette, type scale, logo metadata, and grid densities share a single source of truth.The site covers the full brand system and layers practical tooling on top of the static PDF:
On the tooling side, ESLint with
eslint-plugin-jsdocenforces a documented public API, and Vitest covers the interactive logic: clipboard copy, the toast lifecycle, the luminance-based variant recommendation, type-token formatting, and zip building. Two GitHub Actions workflows were added, one to run lint and tests on every push and pull request, and one to build and deploy the site to GitHub Pages frommain.The change also renames
Guidelines.pdftobrand-guidelines.pdfand ignores the localdocs/working directory.