Skip to content

docs: add the module icon and unify the README badges - #689

Merged
harlan-zw merged 3 commits into
mainfrom
docs/brand-icon
Oct 6, 2026
Merged

harlan-zw merged 3 commits into
mainfrom
docs/brand-icon

Conversation

@harlan-zw

@harlan-zw harlan-zw commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

🔗 Linked issue

Related to harlan-zw/nuxt-seo#647

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

The Nuxt SEO brand refresh gives each module a hand-drawn icon. The README heading now opens with the Sitemap icon and links it to nuxtseo.com.

The icon sits on the dark favicon plate inside the H1, so one SVG in .github/assets/ reads on GitHub's light and dark themes. A <picture> swap follows the OS colour scheme rather than GitHub's theme, so it showed dark ink on a dark page. The scripts/brand-assets.ts generator in harlan-zw/nuxt-seo#647 wrote the file.

The badge row now shows the same five badges in the brand ink and green, with the skilld badge inline as a Markdown badge. The skilld badge picks up the matching flat style and colours once skilld-dev/skilld.dev#458 deploys.

🤖 AI disclosure: Harlan Agent Kit modified this description. My AI open-source policy.

The Nuxt SEO brand refresh gives each module a hand-drawn icon.
The header shows it above the module name. Light and dark cuts
match the reader's GitHub theme.
@harlan-zw harlan-zw added harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review harlan-agent-review Approve automated work for the current issue state or pull request head commit. labels Oct 6, 2026
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

📦 Package Size

✅ No notable size changes

All tracked output (12)
Package output Gzipped Raw
@nuxtjs/sitemap · dependency nuxt-site-config 10 kB 25 kB ✅
@nuxtjs/sitemap · dependency nuxtseo-shared 23 kB 78 kB ✅
@nuxtjs/sitemap · dependency oxc-parser 130 kB 1.35 MB ✅
@nuxtjs/sitemap · dependency radix3 4.3 kB 16 kB ✅
@nuxtjs/sitemap · dependency sitemapd 14 kB 58 kB ✅
@nuxtjs/sitemap · export . 16 kB 67 kB ✅
@nuxtjs/sitemap · export ./content 1.3 kB 4.3 kB ✅
@nuxtjs/sitemap · export ./utils 2.3 kB 8.4 kB ✅
@nuxtjs/sitemap · published payload 60 kB 205 kB ✅
@nuxtjs/sitemap · server runtime 35 kB 110 kB ✅
sitemapd · dependency fast-xml-parser 122 kB 387 kB ✅
sitemapd · published payload 14 kB 58 kB ✅
Runtime dependencies (15)
Package Dependency Requested Resolved Cost
@nuxtjs/sitemap @nuxt/kit ^4.5.2 4.5.2 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap consola ^3.4.2 3.4.2 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap defu ^6.1.7 6.1.7 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap nuxt-site-config ^4.2.3 4.2.3 📦 10 kB gzip
@nuxtjs/sitemap nuxtseo-shared ^5.3.16 5.3.16 📦 23 kB gzip
@nuxtjs/sitemap ofetch ^1.5.1 1.5.1 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap oxc-parser ^0.141.0 0.141.0 📦 130 kB gzip
@nuxtjs/sitemap oxc-walker ^1.1.1 1.1.1 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap pathe ^2.0.3 2.0.3 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap pkg-types ^2.3.1 2.3.1 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap radix3 ^1.1.2 1.1.2 📦 4.3 kB gzip
@nuxtjs/sitemap sitemapd workspace:^ 0.2.2 📦 14 kB gzip
@nuxtjs/sitemap ufo ^1.6.4 1.6.4 ♻️ free via Nuxt 4.5.2
@nuxtjs/sitemap ultrahtml ^1.7.0 1.7.0 ♻️ free via Nuxt 4.5.2
sitemapd fast-xml-parser ^5.11.0 5.11.0 📦 122 kB gzip

Baseline: main_@_b593d1d___2026-10-06 · gzip is the comparison metric · changes below 16 B gzip are ignored

@pkg-pr-new

pkg-pr-new Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@nuxtjs/sitemap@689

commit: edcd0cf

@harlan-zw harlan-zw added harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. harlan-agent-running An Agent holds a Task on this issue or pull request right now. and removed harlan-agent-review Approve automated work for the current issue state or pull request head commit. labels Oct 6, 2026
@harlan-zw

harlan-zw commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator Author

🤖 MERGED

Harlan Agent Kit posted this automated review. It is not Harlan's personal review or approval. AI open source policy. Last updated: 2026-10-06 08:39 UTC.

GitHub merged this pull request.

  • Logged (25/100): The new relative icon path renders on GitHub but shows a broken image on the npm package page. View code
    • Ask an agent to verify and fix this finding

b3d3ee94-cd42-4af8-8268-8069b82e464e

Selected findings run after merge and open separate pull requests.

@harlan-zw harlan-zw added harlan-agent-ready The automated Review passed every gate on this head commit. and removed harlan-agent-running An Agent holds a Task on this issue or pull request right now. harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review labels Oct 6, 2026
GitHub swaps <picture> sources by the OS colour scheme, not by its own theme, so the dark-ink icon showed on GitHub's dark theme. The icon now sits on the dark favicon plate inside the H1. One SVG reads on both themes.
@harlan-zw harlan-zw added harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review harlan-agent-review Approve automated work for the current issue state or pull request head commit. harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. and removed harlan-agent-review Approve automated work for the current issue state or pull request head commit. labels Oct 6, 2026
Every Nuxt SEO README now shows the same five badges in the brand's ink and green. The skilld badge becomes a Markdown badge in the row, so it no longer drops to its own line.
@harlan-zw harlan-zw added harlan-agent-review Approve automated work for the current issue state or pull request head commit. harlan-agent-running An Agent holds a Task on this issue or pull request right now. harlan-agent-ready The automated Review passed every gate on this head commit. and removed harlan-agent-review Approve automated work for the current issue state or pull request head commit. harlan-agent-ready The automated Review passed every gate on this head commit. harlan-agent-running An Agent holds a Task on this issue or pull request right now. harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. labels Oct 6, 2026
@harlan-zw harlan-zw changed the title docs: add the module icon to the README header docs: add the module icon and unify the README badges Oct 6, 2026
@harlan-zw
harlan-zw merged commit 62d2918 into main Oct 6, 2026
7 checks passed
@harlan-zw harlan-zw removed the harlan-agent-ready The automated Review passed every gate on this head commit. label Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant