Skip to content

docs: drop the redundant (feature-id) suffix from feature READMEs - #78

Merged
baxyz merged 3 commits into
mainfrom
docs/uniform-feature-titles
Sep 7, 2026
Merged

docs: drop the redundant (feature-id) suffix from feature READMEs#78
baxyz merged 3 commits into
mainfrom
docs/uniform-feature-titles

Conversation

@baxyz

@baxyz baxyz commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Summary

The website's Features sidebar showed an inconsistent mix of "Label (name)" and "Label" entries — because 15 of 20 feature READMEs had "(feature-id)" appended to their H1, and the other 5 didn't. The H1 becomes the page title / sidebar label on helpers4.dev.

  • Drop the (feature-id) suffix from the 15 READMEs that had it (angular-dev, claude-dev, cline-dev, copilot-dev, dotfiles-sync, essential-dev, github-dev, mistral-dev, nub, package-auto-install, peon-ping, playwright-dev, pnpm-store, typescript-dev, vite-plus).
  • Align the 3 that still didn't match their devcontainer-feature.json name field: git-absorb ("git-absorb" → "git absorb — Automatic Fixup Commits"), helpers4-common ("helpers4-common" → "helpers4 Common Library"), pnpm-store ("pnpm Store" → "pnpm Store (shared)").
  • Add a > Code name: \`line right after the H1 on all 20 READMEs, before the description — so the natural-language title and the literal feature id used indevcontainer.json/ghcr.io/helpers4/devcontainer/` are both visible, consistently placed everywhere.

A companion website change (helpers4/website#78) now sources the generated page title directly from devcontainer-feature.json's name field instead of parsing the README H1, so title and README can no longer drift apart again regardless of README wording.

Test plan

  • Confirmed every feature README's H1 matches its devcontainer-feature.json name field
  • Confirmed every feature README has a Code name line right after its H1
  • After merge + website docs regen, confirm the Features sidebar shows uniform labels and each page shows its code name

🤖 Generated with Claude Code

15 of 20 feature READMEs had "(feature-id)" appended to their H1
(e.g. "Angular Development Environment (angular-dev)"), the other 5
didn't — this H1 becomes the page title and sidebar label on
helpers4.dev, so the site's Features sidebar showed an inconsistent
mix of "Label (name)" and "Label" entries. Drop the suffix everywhere:
the id is already the URL slug and the grouping context, so it added
nothing.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown

✅ PR Validation Passed

All checks passed!


📋 Pipeline Status

Job Status
🧾 Conventional Commits passing
🔖 Version Bump passing
🧪 Feature Tests passing
🐚 ShellCheck passing

🤖 Generated by @helpers4 CI • 2026-09-07

git-absorb, helpers4-common, and pnpm-store used their bare feature id
as the README H1 instead of the display name already declared in
devcontainer-feature.json's "name" field ("git absorb — Automatic
Fixup Commits", "helpers4 Common Library", "pnpm Store (shared)").
Every other feature's README already matched its JSON name (or now
does, after the previous commit) — align these 3 too, so the README's
own title is never a second, independently-drifting copy of the name.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The previous two commits made every README's H1 match its natural-
language display name — but that alone left no visible link back to
the actual feature id (angular-dev, git-absorb, ...) used in
devcontainer.json and ghcr.io/helpers4/devcontainer/<id>. Add a
"> Code name: `<id>`" line right after the H1, before the description,
on all 20 active features — consistent placement everywhere, whether
the README already had a self-heal note, a naming caveat, or nothing
else before its description paragraph.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
baxyz added a commit to helpers4/website that referenced this pull request Sep 7, 2026
Follow-up to helpers4/devcontainer#78, which adds a "Code name: <id>"
line right after every feature README's H1.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@baxyz
baxyz merged commit fd4c4fa into main Sep 7, 2026
39 checks passed
@baxyz
baxyz deleted the docs/uniform-feature-titles branch September 7, 2026 17:21
baxyz added a commit to helpers4/website that referenced this pull request Sep 7, 2026
…ture.json

The generator took each feature's page title (and, with no sidebar.label
set, its sidebar entry too) from the README's H1 — but 15 of 20 READMEs
had a redundant "(feature-id)" suffix the other 5 didn't, so the Features
sidebar showed an inconsistent mix of "Label (name)" and "Label" entries.

Source the title from devcontainer-feature.json's "name" field instead —
the Dev Container Feature spec's own canonical display name, already
present and consistent for every feature — falling back to the README H1
only if a feature's manifest is somehow missing that field. The README's
H1 is still stripped from the body either way, to avoid a duplicate
heading under Starlight's own frontmatter-title heading.

Regenerated all 20 feature pages; titles now read the same as
helpers4/devcontainer#78's aligned README headings, but can no longer
drift apart from them since the site never parses the README title again.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
baxyz added a commit to helpers4/website that referenced this pull request Sep 7, 2026
Follow-up to helpers4/devcontainer#78, which adds a "Code name: <id>"
line right after every feature README's H1.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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