Repository navigation
docs: normalize per-image README headings and shared sections - #164
Merged
Merged
Conversation
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
# Conflicts: # .claude/CLAUDE.md
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.
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
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, rootREADME.md: removed emoji from headingsbun,hugo-bun,hugo-bun-node: renamedVersion Information→Build Args(the section lists ARG defaults, andBuild Argsis claude-code's name for it), reordered, and added a two-lineImage Tagssection derived from each build workflowclaude-bun: renamedQuick Start→Usage, movedImage Tagsup, and addedMulti-platform Support(its workflow builds amd64 and arm64)ralphex-fe: renamedBuilding Locally→Building the Imageand addedMulti-platform Support.claude/CLAUDE.md: one Code Style bullet stating the ruleNotes
claude-code/README.mdis untouched (feat(claude-code): bake happy CLI into default and sandbox images #131, feat(claude-code): upgrading-dependencies skill; sync skill 1.2.0 #136 and feat(images): provide MDN MCP server via managed settings #153 edit it). It still hasQuick Start.ralphex-feis not reordered, because feat(images): provide MDN MCP server via managed settings #153 edits lines around## Usage.hugo-bunlists Hugo 0.152.2 / Bun 1.3.2; the Dockerfile has 0.155.1 / 1.3.8.hugo-bun-nodelists Node 24.13.0; the Dockerfile has 24.21.0.ralphex-fe's Tools table and tag example are several versions behind.bunandhugo-bun*examples useghcr.io/<USERNAME>/…rather thangatezh..github/copilot-instructions.mdis a broken symlink to a nonexistentAGENTS.md.Fixes #132