Repository navigation
Add a README section icon pack and brand the README badges - #2
Merged
Merged
Conversation
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>
1 of 2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Section icon pack.
generator/section-icons.mjsrenders 17 icons intoassets/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/octicons19.42.0, MIT) in console blue#012456on a highlighter yellow#FFD02Btile, with corner radius and glyph size taken from the website's.abr-icon.getting-started(rocket)supported-versions/unsupported-versionssystem-requirements(tools)required-privileges(shield lock)authentication(key)language-support(globe)module-installation(download)configuration(gear)examples(terminal),example-index,commandssample-reports(book)export-diagrams,log-collectionknown-issues(bug)in-development(alert)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 fromreadme-banners.mjs) now applies the whole brand throughreadme-brand.mjs:1F5FD0for versions,012456for counts (downloads, contributors),FFD02Bfor 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, becausefeature/readme-bannerstill 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)width,heightandalignattributesrepo-bannersartifact from this PR's run includesassets/section-icons🤖 Generated with Claude Code