DOC-386: Split lstk CLI docs into a multi-page structure - #898
Merged
Conversation
The lstk.mdx reference had grown to 1577 lines covering install, auth, configuration, ~20 subcommands, CI/automation topics, and FAQ/troubleshooting in one page. Split it into nine focused pages under running-localstack/lstk/: - index.mdx: overview, install, quick start, shell completions - authentication.md: login/logout concept + command reference - configuration.mdx: config.toml, emulator types, env vars, volumes - lifecycle-commands.md: start/stop/restart/status/logs/reset/volume - aws-and-iac-commands.md: aws/az/terraform/cdk/sam proxies - snapshots.md: snapshot save/load/list/remove/show, S3 remotes - automation.mdx: global options, structured output, env vars, OTel - setup-and-maintenance.md: setup/config/update, offline/enterprise - faq-and-troubleshooting.md: FAQ and troubleshooting combined Also fixes a pre-existing bug where "setup azure" was documented twice with slightly different text, and updates the ~110 files site-wide that linked to specific anchors on the old single page so they point at the new page + anchor, plus the six _redirects entries that pointed at the old #snapshot anchor. The main lstk URL (/aws/developer-tools/running-localstack/lstk/) is unchanged, so no redirect is needed for it specifically.
quetzalliwrites
requested review from
HarshCasper,
alexrashed,
anisaoshafi,
bentsku,
carole-lavillonniere,
dfangl,
dmacvicar,
dominikschubert,
giograno,
hovaesco,
joe4dev,
jw2,
k-a-il,
nik-localstack,
pandomic,
pinzon,
silv-io,
skyrpex,
steffyP,
tiurin and
viren-nadkarni
as code owners
August 27, 2026 11:44
Collaborator
Author
|
Hey @mmaureenliu here's the new Information Architecture for the preview url: https://666ff3a9.localstack-docs.pages.dev/aws/developer-tools/running-localstack/lstk/ |
mmaureenliu
approved these changes
Sep 1, 2026
mmaureenliu
left a comment
mmaureenliu
left a comment
There was a problem hiding this comment.
This looks great and so much more readable! Thanks!
I've left a few comments but none are blocking so approved already.
I assume all redirects work and skim-read most contents.
- Rename aws-and-iac-commands.md to cloud-and-iac-commands.md (and its title/sidebar label) since the page covers the Azure CLI too, not just AWS. Sweeps every cross-reference site-wide. - Drop the "S3 remotes" mention from the Snapshots overview bullet and lead with "save and load emulator state" instead. - Note that the config.toml `type` field reflects whichever emulator was chosen at first run. - Correct the snapshot support note: only the Snowflake emulator has experimental snapshot support today, not Azure (Azure persistence is still WIP). Move the `reset` AWS-only note to the `reset` command's own section in lifecycle-commands.md instead of the snapshots page, since reset no longer lives there. - Give the `save`/`load` aliases their own subheading instead of a trailing paragraph. - Note in the FAQ that `lstk reset` is AWS-only.
Deploying localstack-docs with
|
| Latest commit: |
61c070e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f4d363ba.localstack-docs.pages.dev |
| Branch Preview URL: | https://doc-386-docs-lstk-docs-v2.localstack-docs.pages.dev |
Collaborator
Author
|
Thanks @mmaureenliu — pushed
|
This was referenced Sep 1, 2026
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
2 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.
Why this new Information Architecture update is valuable:
The current single
lstk.mdxpage has grown to 1577 lines and roughly 20 subcommands ...all crammed into one loooooooooooooong continuously-scrolling reference sort of unclean hallway closet type of doc.That's really really really bad UX, so time for some new Information Architecture 😸
New sub-section content:
Now a customer knows at first glance what they can do with
lstk.Why 9 pages sounds like "a lot" until you actually look
It's not an arbitrary split, it maps directly onto the natural boundaries already in the current content:
Once you see the source page's actual length and how many unrelated concerns were stacked on top of each other, 9 focused, individually-linkable pages finally gave each topic room to breathe. 👯
Preview url: https://666ff3a9.localstack-docs.pages.dev/aws/developer-tools/running-localstack/lstk/