Skip to content

docs: lead the README with Terraform validation - #38

Merged
sanlega merged 2 commits into
mainfrom
docs/33-readme-positioning
Nov 13, 2026
Merged

sanlega merged 2 commits into
mainfrom
docs/33-readme-positioning

Conversation

@sanlega

@sanlega sanlega commented Nov 13, 2026

Copy link
Copy Markdown
Owner

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:

  • New hero: "Test your Terraform on local AWS before it touches the real one." + one paragraph (memory for the official emulator, same IDs after restarts, PRs applied on top of main, no account, no tokens).
  • New Two ways to use it block: on your machine / in every pull request, each linking to its section.
  • Validate pull requests moved right after the Quick start (was a subsection of "In GitHub Actions"), with an example of the PR comment generated by the real renderer (validate.render_markdown) from a sample report: a replacement and a non-idempotent resource.
  • Feature table: validation and the incremental baseline first; "Survives everything" now mentions crashes mid-apply and links to the crash-safety section added in fix(proxy): crash safety, do not execute writes abandoned by their client #35 (merge that one first).
  • Same structure and wording in docs/i18n/README.es.md and README.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 by keepstack.validate.render_markdown, so it matches what users will see.

@sanlega sanlega added this to the v0.4.0 milestone Nov 13, 2026
@sanlega sanlega added the type: docs Documentation only label Nov 13, 2026
@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

keepstack validate: examples/quickstart ✅ passed

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
sanlega force-pushed the docs/33-readme-positioning branch from 75430d1 to 80a9ab3 Compare November 13, 2026 00:52
@sanlega
sanlega merged commit accb158 into main Nov 13, 2026
12 checks passed
@sanlega
sanlega deleted the docs/33-readme-positioning branch November 13, 2026 00:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: lead with Terraform validation, persistence as the engine

1 participant