Skip to content

Remove the title heading and follow badge from module READMEs - #4

Merged
tpcarman merged 1 commit into
mainfrom
feature/readme-title-follow
Nov 14, 2026
Merged

tpcarman merged 1 commit into
mainfrom
feature/readme-title-follow

Conversation

@tpcarman

Copy link
Copy Markdown
Contributor

Summary

The README rollout (readme-prs.mjs, via readme-brand.mjs) now also makes two removals:

  • Title heading: removes the heading below the badges, such as # VMware vSphere As Built Report or # AsBuiltReport.Core, because the banner already names the repo. It is the first level 1 heading before any known section. Lower-level headings above it are skipped: the "community maintained" notice in Microsoft.AD, Microsoft.SCVMM, Veeam.VB365 and Veeam.VBR is a level 4 heading. The blank line after the title goes too. Microsoft.Azure has no title (its first heading is Getting Started), so it is left alone.
  • X follow badge: removes the centred paragraph holding the follow @AsBuiltReport badge (27 READMEs). Diagram's follow badge is for @rebelinux, so it is kept.

Test plan

  • node --test: 20 unit tests, plus 31 checks against the current READMEs (including the open PR branches), now also asserting that no title heading or follow @AsBuiltReport badge is left, and that a second run changes nothing
  • Listed what goes from each README: 30 titles, 27 follow badges, nothing from Azure's headings

🤖 Generated with Claude Code

The README rollout now also removes:
- the title heading below the badges, such as "# VMware vSphere As
  Built Report", because the banner already names the repo. It is the
  first level 1 heading before any known section, skipping the
  "community maintained" notice some READMEs have above it.
- the X (Twitter) follow @AsBuiltReport badge. Follow badges for other
  accounts are kept.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tpcarman
tpcarman merged commit 3d7c4ae 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