Skip to content

docs: normalize per-image README headings and shared sections - #164

Merged
gatezh merged 2 commits into
masterfrom
docs/readme-normalize
Sep 23, 2026
Merged

gatezh merged 2 commits into
masterfrom
docs/readme-normalize

Conversation

@gatezh

@gatezh gatezh commented Sep 23, 2026

Copy link
Copy Markdown
Owner

What

Normalizes the per-image READMEs in place (option a from #132). Headings are now plain text, and the shared sections have one name and one order. The rule is recorded in .claude/CLAUDE.md.

Why

The READMEs had drifted apart: four used plain headings and two used emoji, and the same concept appeared under different names (Multiplatform Support/Multi-platform Support, Version Information/Build Args, Quick Start/Usage). Each README stays self-contained so it still reads correctly on its own, e.g. on the ghcr package page.

Changes

  • Canonical order: Features → Multi-platform Support → Image Tags → Usage → image-specific sections → Build Args → Building the Image → Resources → License → Contributing. Each name is the one most READMEs already used.
  • hugo-bun, hugo-bun-node, root README.md: removed emoji from headings
  • bun, hugo-bun, hugo-bun-node: renamed Version Information → Build Args (the section lists ARG defaults, and Build Args is claude-code's name for it), reordered, and added a two-line Image Tags section derived from each build workflow
  • claude-bun: renamed Quick Start → Usage, moved Image Tags up, and added Multi-platform Support (its workflow builds amd64 and arm64)
  • ralphex-fe: renamed Building Locally → Building the Image and added Multi-platform Support
  • .claude/CLAUDE.md: one Code Style bullet stating the rule

Notes

Fixes #132

Drop emoji from all README headings (hugo-bun, hugo-bun-node, root) and
give the shared sections one name and one order across per-image READMEs:
Features -> Multi-platform Support -> Image Tags -> Usage -> image-specific
-> Build Args -> Building the Image -> Resources -> License -> Contributing.

- "Multiplatform Support" -> "Multi-platform Support"; added to claude-bun
  and ralphex-fe, which are built for amd64 and arm64 but did not say so
- "Version Information" -> "Build Args" (the section documents ARG
  defaults, matching claude-code's name for the same concept)
- bun, hugo-bun, hugo-bun-node gain a two-line "Image Tags" section
- claude-bun "Quick Start" -> "Usage"; ralphex-fe "Building Locally" ->
  "Building the Image"

Per-image tag schemes are unchanged. claude-code/README.md is untouched
(already conforms on the shared names), and ralphex-fe is not reordered,
to avoid conflicts with open PRs. The rule is recorded in CLAUDE.md.

Fixes #132
@gatezh
gatezh merged commit 2d5f5b8 into master Sep 23, 2026
14 checks 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.

Per-image READMEs have drifted in heading style and duplicated boilerplate

1 participant