Skip to content

Add a README section icon pack and brand the README badges - #2

Merged
tpcarman merged 1 commit into
mainfrom
feature/section-icons
Nov 14, 2026
Merged

tpcarman merged 1 commit into
mainfrom
feature/section-icons

Conversation

@tpcarman

Copy link
Copy Markdown
Contributor

Summary

Section icon pack. generator/section-icons.mjs renders 17 icons into assets/section-icons/, to replace the emoji on the section headings of module READMEs. They match the feature icons on www.asbuiltreport.com: an Octicons glyph (pinned @primer/octicons 19.42.0, MIT) in console blue #012456 on a highlighter yellow #FFD02B tile, with corner radius and glyph size taken from the website's .abr-icon.

Icon Replaces
getting-started (rocket) 🔰 Getting Started
supported-versions / unsupported-versions 💾 / 🚫
system-requirements (tools) 🔧
required-privileges (shield lock) 🔐
authentication (key) 🔑
language-support (globe) 🌐 🗺️
module-installation (download) 📦
configuration (gear) ✏️
examples (terminal), example-index, commands 💻, 📘, ✏️
sample-reports (book) 📚
export-diagrams, log-collection 📈, 📝
known-issues (bug) ❌ 🐛 ❗ 🚨
in-development (alert) the ❗ in-development notice

Each is a 32 px SVG for READMEs and a 96 px PNG, and the folder has a catalogue README. The list lives in section-icons.json, including the heading texts each icon replaces.

README rollout. readme-prs.mjs (renamed from readme-banners.mjs) now applies the whole brand through readme-brand.mjs:

  • the banner, as before
  • section icons in place of the emoji on known headings, sized to the heading level (28/24/20 px), skipping headings inside code blocks
  • badges in the palette: 1F5FD0 for versions, 012456 for counts (downloads, contributors), FFD02B for compatibility (platform). Licence, last commit and Twitter badges are unchanged.

It commits to an already open PR rather than opening a second one. It uses the branch feature/readme-brand, because feature/readme-banner still exists in Microsoft.Azure after #44 merged.

Workflow. Runs node --test, then renders the icons with the banners and commits them.

Test plan

  • node --test: 10 unit tests, plus 31 checks against the live module READMEs (nothing changes outside the banner, badges and headings; a second run changes nothing)
  • All 260 emoji section headings across the 31 READMEs get an icon, and none are left
  • Checked the icons on GitHub light and dark backgrounds, and that GitHub keeps the width, height and align attributes
  • Dry run for Microsoft.Azure: 4 badges and 8 headings change
  • Check the repo-banners artifact from this PR's run includes assets/section-icons

🤖 Generated with Claude Code

section-icons.mjs renders 17 icons for the section headings of module
READMEs (Getting Started, System Requirements, Required Privileges and
so on) into assets/section-icons/, as SVG and PNG with a catalogue.
They follow the feature icons on the website: an Octicons glyph in
console blue on a highlighter yellow tile.

The README rollout (readme-banners.mjs, renamed readme-prs.mjs) now
applies the whole brand through readme-brand.mjs: the banner, icons in
place of emoji on known section headings, and badges in the brand
palette (link blue for versions, console blue for counts, highlighter
for compatibility). It commits to an open pull request's branch rather
than opening a second one, and uses a new branch name, because the
earlier banner branches remain after their pull requests merge.

The workflow runs the new tests and renders the icons.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tpcarman
tpcarman merged commit 503c37a into main Nov 14, 2026
1 check 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.

1 participant