Skip to content

Refine documentation typography hierarchy - #1493

Merged
cachafla merged 2 commits into
mainfrom
codex/vm-inspired-docs-typography
Aug 28, 2026
Merged

Refine documentation typography hierarchy#1493
cachafla merged 2 commits into
mainfrom
codex/vm-inspired-docs-typography

Conversation

@cachafla

Copy link
Copy Markdown
Contributor

Pull Request Description

What and why?

Refines the documentation typography so it feels closer to the ValidMind product while preserving a comfortable long-form reading size.

  • uses the existing Inter variable font across the available weight range instead of registering only Regular
  • aligns the heading scale and tracking with ValidMind's 30/24/20/18px hierarchy
  • steps Quarto-authored sections down visually beneath the generated page title
  • constrains prose to 75 characters while leaving callouts and cards unconstrained
  • softens section dividers

Before and after

Before After
Release notes before typography changes Release notes after typography changes

How to test

  • skills/validmind-docs-coverage/scripts/render-pages.sh site/releases/cmvm/26.07/release-notes.qmd
  • skills/validmind-docs-coverage/scripts/render-pages.sh site/guide/inventory/working-with-the-inventory.qmd
  • Rendered the exact 26.09 candidate release-note source from validmind/release-notes#138 locally for the after screenshot.
  • cd site && quarto render --profile development — completed all 793 pages. The render retains existing unresolved generated API-reference warnings.

Preview link: pending the validate deployment.

What needs special review?

  • Whether the 30/24/20/18px hierarchy feels sufficiently close to the product without making long-form docs too dense.
  • Whether the 75-character prose measure works across guides as well as full-width release notes.

Dependencies, breaking changes, and deployment notes

No dependencies or breaking changes. This is a global theme change, so CI should perform the complete preview render.

Release notes

Documentation now uses a clearer typography hierarchy aligned with the ValidMind platform, with tighter headings and more readable line lengths.

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut — not applicable
  • Unit tests added (Backend) — not applicable
  • Tested locally
  • Documentation updated
  • Environment variable additions/changes documented — not applicable

@cachafla cachafla added the documentation Improvements or additions to documentation label Aug 28, 2026
@cachafla
cachafla marked this pull request as ready for review August 28, 2026 06:05
@cachafla
cachafla merged commit d88ac1d into main Aug 28, 2026
2 checks passed
@cachafla
cachafla deleted the codex/vm-inspired-docs-typography branch August 28, 2026 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant