Guidelines: add a typography usage page

Closed
#185 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript

Research direction

Start with lib/guidelines/pages/color-usage.ts, the most recent usage page, and lib/guidelines/registry.ts, where pages are registered. Check lib/typography/scale.ts for the live sizes the new page should read, and lib/a11y/readability.ts for the line-length and line-height guidance. Done means the page can be toggled off, appears in numbering, contents, PDF bookmarks and the website when on, and renders correctly in light and dark modes.

Written by the indexing model from the issue text.

Description

area: guidelines difficulty: medium enhancement help wanted

Summary

Add a Typography usage page to the brand book: a heading and body hierarchy built from the type scale, recommended line lengths and line heights, and two don'ts (too many weights, all caps body text).

Where to look

  • lib/guidelines/pages/color-usage.ts: the most recent usage page
  • lib/typography/scale.ts and lib/a11y/readability.ts
  • lib/guidelines/registry.ts

Acceptance criteria

  • The page can be switched off; numbering, contents, PDF bookmarks and the website include it.
  • Sizes come from the live type scale.
  • Light and dark both work.

Getting started: fork the repo, then pnpm install and pnpm dev (Node 22+, pnpm 11, no API keys). Before opening a PR, run pnpm typecheck && pnpm test && pnpm lint && pnpm format:check && pnpm check:dashes && pnpm build. See CONTRIBUTING.md and the first contribution walkthrough.

Everything needed is in the repository. This doesn't need maintainer access, secrets or paid services. Comment below to claim it, and ask questions here any time.

Dominant language
TypeScript
Stars
11
Forks
3
Avg merge
5h 23m
Merged PRs (30d)
74

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from yakew7/DesignHub

All issues in yakew7/DesignHub

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.