Skip to content

chore: docs restyle for new landing page#3210

Open
tac0turtle wants to merge 1 commit intomainfrom
marko/docs_restyle
Open

chore: docs restyle for new landing page#3210
tac0turtle wants to merge 1 commit intomainfrom
marko/docs_restyle

Conversation

@tac0turtle
Copy link
Copy Markdown
Contributor

Overview

This pr ties and is blocked by the new landing page being launched

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Mar 30, 2026

Claude finished @tac0turtle's task in 1m 55s —— View job


Code Review

  • Gather context and understand PR scope
  • Review docs/.vitepress/config.ts
  • Review docs/.vitepress/theme/style.css
  • Review docs/index.md
  • Review docs/package.json and lock files
  • Review new assets (favicons, logos, og-image)
  • Summarize findings

Overall this is a clean visual restyle. The brand tokens, typography, and component styling are well-organized. A few issues below range from a real bug to minor nits.

Bug: malformed og:description in transformPageData

docs/.vitepress/config.ts:146 — The og:description meta tag value is broken:

// current (broken)
content: pageData.frontmatter.layout === `${pageData.description}`,

This evaluates to a boolean (true/false) because it's a strict equality check, not an assignment. Every page will have og:description set to "false". Should be:

content: pageData.frontmatter.layout === "home"
  ? "Own It. Shape It. Launch It."
  : `${pageData.title} | Evolve`,

Fix this →


Accessibility: user-scalable=no in viewport meta

docs/.vitepress/config.ts:52-54

content: "width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no",

user-scalable=no / maximum-scale=1.0 prevents browser zoom, which fails WCAG 1.4.4 (Resize Text, Level AA). Users with low vision who rely on pinch-zoom will have a degraded experience. Consider removing maximum-scale=1.0, user-scalable=no.

Fix this →


Logo dark mode configuration

docs/.vitepress/config.ts:121-125

logo: {
  alt: "Evolve Logo",
  light: "/img/evolve-logo-dark.svg",  // black paths — correct for light bg
  dark: "/img/evolve-logo-dark.svg",   // black paths — invisible on dark bg
},

Both variants point to evolve-logo-dark.svg (black fill). Since appearance: false disables dark mode this is harmless today, but if dark mode is ever re-enabled the logo will be invisible. The dark entry should reference /img/evolve-logo.svg (white fill). Worth fixing now to avoid a future surprise.


Mixed package managers: package-lock.json committed alongside yarn.lock

docs/package-lock.json (4302 lines added)

The project uses Yarn (per CLAUDE.md dev commands and the existing yarn.lock). Committing package-lock.json alongside yarn.lock causes confusion about which lockfile is authoritative and can cause CI inconsistencies. The predev/prebuild scripts in package.json also still call npm install rather than yarn install. Recommend removing package-lock.json and keeping only yarn.lock.


Unused import in docs/index.md

docs/index.md:8

<script setup>
import constants from './.vitepress/constants/constants.js'
</script>

constants is imported but never used anywhere in the file. This will produce a build warning and should be removed.

Fix this →


Minor: editLink.pattern points to a different repo

docs/.vitepress/config.ts:117

pattern: "https://github.com/evstack/docs/edit/main/:path",

This links to evstack/docs, not evstack/ev-node. If docs live inside this repo, this should be https://github.com/evstack/ev-node/edit/main/docs/:path. If intentional (docs mirrored to a separate repo), it's fine as-is.


Nit: inline styles in docs/index.md

The <style> block at the bottom of index.md (lines 52–94) would be better placed in style.css so all component styles are in one place. This is a minor consistency concern — the inline style works fine as-is.


Nit: CSS variable usage in style.css

The brand token variables defined at the top of style.css (e.g., --ev-diagonal: #DAE4E7, --ev-purple: #B8A6FF) are defined but then largely not used — the same hex values are repeated inline throughout the file. For example:

/* defined */
--ev-diagonal: #DAE4E7;

/* but then hardcoded 20+ times instead */
border-bottom: 1px solid #DAE4E7 !important;

Using var(--ev-diagonal) etc. would make future brand updates a single-line change.


Summary

Severity Issue
Bug og:description always outputs "false"
Accessibility user-scalable=no blocks zoom for low-vision users
Correctness Dark logo misconfigured (harmless now, breaks if dark mode re-enabled)
Tooling package-lock.json committed alongside yarn.lock
Minor Unused constants import in index.md
Minor editLink repo path may be wrong
Nit Inline styles and CSS variable underuse

@github-actions
Copy link
Copy Markdown
Contributor

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://evstack.github.io/docs-preview/pr-3210/

Built to branch main at 2026-03-30 14:14 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions
Copy link
Copy Markdown
Contributor

The latest Buf updates on your PR. Results from workflow CI / buf-check (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed⏩ skipped✅ passed✅ passedMar 30, 2026, 2:19 PM

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.45%. Comparing base (889da9a) to head (7108ac7).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3210      +/-   ##
==========================================
- Coverage   61.46%   61.45%   -0.02%     
==========================================
  Files         120      120              
  Lines       12462    12470       +8     
==========================================
+ Hits         7660     7663       +3     
- Misses       3944     3947       +3     
- Partials      858      860       +2     
Flag Coverage Δ
combined 61.45% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't checked the content, but the UI looks so much better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants