Repository navigation
Add a README per kit - #17
Merged
Merged
Conversation
GHCR shows the linked repository's README on every package page, so the root README now opens with a Kits table that points to each kit's own README. kit/README.md, examples/hello-lab/README.md and examples/building-images-lab/README.md each give the kit's run command, the ports to pin and what it contains. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
GHCR has no per-package README: a package linked to a repository (through
org.opencontainers.image.source, from the descriptors'sourceUrl) shows that repository's README. The per-package text GHCR does show, theorg.opencontainers.image.descriptionannotation, is already set from each descriptor'sdescription:.So each kit gets its own README, and the root README, which every package page shows, routes to them first:
README.md: a new Kits section right after the intro: one row per kit with its package and a link to its README. The existing quick start moves under Run from source.kit/README.md: the Labspace kit: where the lab comes from, run commands (built-in lab and with a content kit), ports, kit args (appPort,devMode,codeServerVersion).examples/hello-lab/README.md: run command, the pins (8085, 3000), the sections, and how it is packaged.examples/building-images-lab/README.md: run command, the pins (8085, 5050), the seven sections, and the upstream source.Each kit README includes the
kit.allowedSourcessetting and the dedicated-folder step.None of the READMEs end up in the images: the content kits'
.dockerignoreexcludes them, and the kit frontend only stages the descriptor and dockerfile.The
building-images-lab:0.1.4reference resolves only after the next release (0.1.4 was published asbuilding-images).🤖 Generated with Claude Code