docs: update README and docs for v0.16.0#377
Merged
Merged
Conversation
gtsiolis
added
semver: patch
docs: skip
README was missing coverage of several existing but undocumented user-facing features: the `lstk aws` and `lstk sam` proxies, `lstk reset`/`lstk restart`, the `image` config field for custom/offline images, GATEWAY_LISTEN host exposure, the `setup az` alias, extension bundled-dir resolution, the single-`[[containers]]`-block restriction, and the `lstk save`/`lstk load` top-level shortcuts. docs/RELEASING.md didn't mention the automated weekly release workflow (`automated-release.yml`), only the manual tag-creation path. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
gtsiolis
force-pushed
the
claude/keen-edison-wv8fje
branch
from
6339f17 to
b096004
Compare
gtsiolis
changed the title
gtsiolis
changed the title
anisaoshafi
approved these changes
Jul 9, 2026
Member
Author
|
Thanks for merging, @anisaoshafi! 🏀 |
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
3 participants
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.
Summary
Audited
README.md, every file underdocs/, andCLAUDE.md/AGENTS.md(symlinked together) against the current CLI (--helpoutput) and source, and found several real, longstanding documentation gaps.CLAUDE.md/AGENTS.mdanddocs/extensions-authoring.mdwere already accurate and up to date.README.mdanddocs/RELEASING.mdhad gaps.README.md
lstk awsproxy command (distinct fromlstk setup aws's profile setup) — was entirely undocumented.lstk samproxy command and a "SAM Integration" section mirroring the existing Terraform/CDK sections.lstk reset/lstk restartto Features and Usage.imageconfig field to the Fields list and default-config sample (it was referenced under "Offline / enterprise environments" but never actually defined).GATEWAY_LISTEN.lstk setup azalias forlstk setup azure.[[containers]]-block restriction (multiple emulators at once isn't supported).PATH, notPATHonly.lstk save/lstk loadas top-level shortcuts forlstk snapshot save/lstk snapshot load.docs/RELEASING.md
Automated Weekly Releaseworkflow (.github/workflows/automated-release.yml), which runs every Thursday, computes the version bump from merged PR labels, and creates the release tag automatically. Previously only the manualCreate Release Tagpath was documented.Needing a human decision
reset/restart) are user-facing and previously had zero documentation, so this is the first time they're described publicly.Test plan
lstksubcommand and flag vialstk --help/lstk <cmd> --helpagainst the new README content.image,GATEWAY_LISTEN, and thesetup azalias against source (internal/config/containers.go,internal/container/gateway.go,cmd/az.go)..github/workflows/automated-release.yml.Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com