Skip to content

fix: use brand icons for migration sidebar - #492

Merged
Kinfe123 merged 1 commit into
mainfrom
fix/migration-sidebar-brand-icons
Aug 22, 2026
Merged

fix: use brand icons for migration sidebar#492
Kinfe123 merged 1 commit into
mainfrom
fix/migration-sidebar-brand-icons

Conversation

@Kinfe123

@Kinfe123 Kinfe123 commented Aug 22, 2026

Copy link
Copy Markdown
Member

Summary

  • replace the generic file icon on every migration guide with its matching documentation-tool brand mark
  • add one reusable, theme-aware 16px migration icon component and register all eight icons in docs config
  • keep decorative icons hidden from assistive technology while preserving the existing sidebar labels

Verification

  • pnpm exec oxfmt --check on all changed files
  • pnpm exec oxlint website/components/ui/migration-source-icon.tsx website/docs.config.tsx
  • pnpm --dir website exec tsc --noEmit
  • pnpm --dir website build
  • checked the migration sidebar locally on desktop and mobile in dark and light modes; all eight icons render distinctly at 16×16

Summary by cubic

Uses brand icons in the migration sidebar for each documentation source to improve recognition. Previously all guides used a generic file icon; now each guide shows its source’s 16px brand mark. Icons are decorative and hidden from assistive technology, preserving sidebar labels.

  • Adds MigrationSourceIcon (theme-aware via currentColor) and registers eight sources in website/docs.config.tsx.
  • Updates frontmatter icon values in each migration guide to the matching slugs: docusaurus, mintlify, nextra, fumadocs, vitepress, starlight, gitbook, mkdocs.
  • Review: check dark/light contrast and distinct glyphs; confirm aria-hidden and focusable="false" on SVGs.
  • Migration: when adding a new migration guide, set its frontmatter icon to one of the registered slugs to render the correct brand mark.

Written for commit 3d03f9d. Summary will update on new commits.

Review in cubic

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your trial has ended. Reactivate Greptile to resume code reviews.

@vercel

vercel Bot commented Aug 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview Aug 22, 2026 8:53am
farming-labs-docs-docs-cloud Building Building Preview Aug 22, 2026 8:53am

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Aug 22, 2026

Copy link
Copy Markdown

Open in StackBlitz

@farming-labs/astro

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro@492

@farming-labs/astro-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro-theme@492

@farming-labs/docs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/docs@492

@farming-labs/farmjs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/farmjs@492

@farming-labs/theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/theme@492

@farming-labs/next

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/next@492

@farming-labs/nuxt

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt@492

@farming-labs/nuxt-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt-theme@492

@farming-labs/svelte

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte@492

@farming-labs/svelte-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte-theme@492

@farming-labs/tanstack-start

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/tanstack-start@492

commit: 3d03f9d

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.

1 participant