Repository navigation
docs: lead the README with Terraform validation - #38
Merged
Merged
Conversation
keepstack validate:
|
| Step | Result |
|---|---|
| init | ✅ ok |
| plan | ✅ ok |
| apply | ✅ ok |
| idempotency | ✅ ok |
| smoke | ✅ ok |
Plan: 0 to add, 0 to change, 0 to replace, 0 to destroy
keepstack · 19.5 s · AWS Emulator, no AWS account used
sanlega
force-pushed
the
docs/33-readme-positioning
branch
from
November 13, 2026 00:52
75430d1 to
80a9ab3
Compare
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
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.
Closes #33
What and why
Since v0.3.0 keepstack does two things, but the README only sold the first one. It now leads with the outcome, test Terraform on local AWS before it touches the real one, and presents persistence as the engine that makes it possible:
main, no account, no tokens).validate.render_markdown) from a sample report: a replacement and a non-idempotent resource.docs/i18n/README.es.mdandREADME.zh-CN.md; no em dashes.How it was tested
Docs only. Anchors checked (
#validate-pull-requests,#valida-pull-requests,#验证拉取请求,docs/how-it-works.md#crash-safety); the example comment is produced bykeepstack.validate.render_markdown, so it matches what users will see.