DOC-326: Simplify README to defer to full lstk documentation#406
Merged
Conversation
The README duplicated most of the comprehensive lstk reference now published at docs.localstack.cloud. Trim it to what a README is for: what the tool is, how to install it, a quick start, and a short feature list, linking out to the full docs for command reference, configuration, and troubleshooting.
Contributor
Author
|
ready for you @mmaureenliu ! |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM 🎉 — the trim keeps the front-of-the-box essentials (install, quick start, feature list) and defers the rest to the docs site, exactly what the ticket asks; I verified every retained link resolves on main (CONTRIBUTING.md, docs/extensions-authoring.md, docs/structured-output.md) and the sole internal anchor [Installation](#installation) still matches its heading, @quetzalliwrites.
Note
This session cannot submit an approving review, so this is posted as a comment — but there are no blocking items; treat it as an approve.
Generated by Claude Code
mmaureenliu
approved these changes
Jul 23, 2026
mmaureenliu
left a comment
mmaureenliu
left a comment
There was a problem hiding this comment.
That's so much neater! Thank you very much!
4 tasks
anisaoshafi
approved these changes
Jul 23, 2026
anisaoshafi
added
semver: patch
docs: skip
Member
|
Thanks, everyone! Merging... |
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
4 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
lstkreference now published at docs.localstack.cloud (config reference, full command list, snapshots, env vars, cloud CLI proxy details, etc.).docs/extensions-authoring.mdanddocs/structured-output.md(repo-local supplementary docs not duplicated on the docs site), and added a link toCONTRIBUTING.md.Linear: https://linear.app/localstack/issue/DOC-326/simplify-lstk-readme
Test plan