Skip to content

Add a README per kit - #17

Merged
mathieu-benoit merged 2 commits into
mainfrom
kit-readmes
Nov 18, 2026
Merged

mathieu-benoit merged 2 commits into
mainfrom
kit-readmes

Conversation

@mathieu-benoit

Copy link
Copy Markdown
Owner

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, the org.opencontainers.image.description annotation, is already set from each descriptor's description:.

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.allowedSources setting and the dedicated-folder step.

None of the READMEs end up in the images: the content kits' .dockerignore excludes them, and the kit frontend only stages the descriptor and dockerfile.

The building-images-lab:0.1.4 reference resolves only after the next release (0.1.4 was published as building-images).

🤖 Generated with Claude Code

mathieu-benoit and others added 2 commits November 18, 2026 12:12
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>
@mathieu-benoit
mathieu-benoit merged commit 3d49e03 into main Nov 18, 2026
4 checks passed
@mathieu-benoit
mathieu-benoit deleted the kit-readmes branch November 18, 2026 17:40
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