Skip to content

docs: update README and docs for v0.18.0#407

Open
gtsiolis wants to merge 1 commit into
mainfrom
claude/sweet-dijkstra-y0u2by
Open

docs: update README and docs for v0.18.0#407
gtsiolis wants to merge 1 commit into
mainfrom
claude/sweet-dijkstra-y0u2by

Conversation

@gtsiolis

@gtsiolis gtsiolis commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

Audited README.md, CLAUDE.md, every internal/*/CLAUDE.md, and every file under docs/ against current source for the v0.18.0 release, covering the full range since the last docs update (docs: update README and docs for v0.17.1, #389).

Most of the delta since then was already documented in-PR (--type flag, LSTK_MERGE_STRATEGY, SIGINT/SIGTERM forwarding, the bash-completion fix, the emulator-selection fix). Cross-checking lstk --help output, the Makefile, and source against the docs turned up a few real gaps:

Needing a human decision

None — no public-messaging wording changed; all additions describe existing, already-shipped behavior.

Test plan

  • make build succeeds
  • Cross-checked lstk --help and lstk logs --help output against the new README content
  • Verified the filterHostEnv drop rules against internal/container/start.go
  • Verified the Makefile's build/test-integration targets against the corrected CLAUDE.md wording
  • Docs-only change; no other build/test impact

Co-Authored-By: Claude <noreply@anthropic.com>

Co-Authored-By: Claude <noreply@anthropic.com>
@gtsiolis
gtsiolis requested a review from a team as a code owner July 23, 2026 13:30
@gtsiolis gtsiolis added semver: patch docs: skip Pull request does not require documentation changes labels Jul 23, 2026 — with Claude
@gtsiolis

Copy link
Copy Markdown
Member Author

Heads-up: Probably not as relevant after we merge #406, may have to revisit or close.

Copy link
Copy Markdown
Member Author

Good catch — checked #406's diff: it removes the README's Features list, Environment Variables table, "Passing environment variables to the container" section, and Usage examples entirely (in favor of linking out to docs.localstack.cloud), which is exactly the content three of my four changes here touch.

The CLAUDE.md and internal/container/CLAUDE.md changes (the stale make build note, the missing proc/ package, and the new "Host environment forwarding" reference section) are unaffected either way — those aren't part of the README trim.

Plan: once #406 merges, I'll rebase this PR and drop the now-nonexistent README hunks, keeping only the CLAUDE.md fixes. Let me know if you'd rather I just close this one and let a future docs-sync pass pick up the CLAUDE.md fixes fresh instead.


Generated by Claude Code

@gtsiolis gtsiolis self-assigned this Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs: skip Pull request does not require documentation changes semver: patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant