Skip to content

docs: add a performance guide (#472) - #483

Merged
yakew7 merged 1 commit into
yakew7:mainfrom
minutechreview:docs/performance-guide-472
Oct 30, 2026
Merged

yakew7 merged 1 commit into
yakew7:mainfrom
minutechreview:docs/performance-guide-472

Conversation

@minutechreview

Copy link
Copy Markdown
Contributor

Summary

Adds docs/performance.md, one short guide to the performance tools: bundle size and budgets, the unused code check, Lighthouse, long tasks in the end-to-end tests and the autosave counters. Each section says what the tool measures, how to run it and how to read the result. It includes a worked example of measuring the longest task of an interaction, based on the pattern in tests/e2e/font-browser.spec.ts. The guide is linked from the Lighthouse section of CONTRIBUTING.md and from the Scripts section of the README. It is 106 lines.

Closes #472

Screenshots

None, docs only.

Checklist

  • pnpm typecheck, pnpm test, pnpm lint, pnpm check:dashes and pnpm build pass
  • Conventional commit messages (feat:, fix:, docs:, chore:)
  • Tested in dark and light themes and at mobile width (375 px) (not applicable, docs only)
  • Works with keyboard only (not applicable, docs only)
  • No any, no console.log, no new external services without a note in .env.example
  • Docs and CHANGELOG.md updated if behavior changed (no behavior change)

Breaking changes

None.

Testing completed

I ran every command in the guide on a fresh main build:

  • pnpm build, then pnpm bundle:size: every route is within its budget. pnpm bundle:size --json bundle-size-main.json followed by pnpm bundle:size --base bundle-size-main.json shows the "Change vs base" and "Status" columns (all 0, ok).
  • pnpm check:unused: exit 0, only the .css configuration hint.
  • pnpm dlx @lhci/cli autorun (with CHROME_PATH set): 25 runs over the 5 pages, exit 0. Reports written to .lighthouseci/. Performance warnings on /brand (0.86), /typography (0.85) and /social (0.88) on my machine, which the guide uses to show how to read a warning.
  • pnpm exec playwright install chromium, then pnpm exec playwright test tests/e2e/font-browser.spec.ts tests/e2e/background-picker.spec.ts: 3 passed. The isometric test failed on my busy machine with Expected: < 300, Received: 366. That is unchanged main code, and it is the example of reading a long-task failure in the guide.
  • pnpm dev, then __designhubSaves() in the browser console: it returned for example {"requested":2,"written":0,"skipped":2,"coalesced":1} on /projects. With no project open, /colors edits counted requested only, which the guide notes.
  • pnpm format:check && pnpm check:dashes pass, and so do pnpm typecheck, pnpm test (2743 tests) and pnpm lint.

Signed-off-by: minutechreview <141821420+minutechreview@users.noreply.github.com>
@vercel

vercel Bot commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

@minutechreview is attempting to deploy a commit to the yashkewlani2020-gmailcom's projects Team on Vercel.

A member of the Team first needs to authorize it.

@yakew7
yakew7 merged commit 95f639e into yakew7:main Oct 30, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: a performance guide for contributors

2 participants