Skip to content

docs: use review instead of walk in the production readiness pages - #2047

Merged
octonato merged 1 commit into
mainfrom
docs/readiness-review-wording
Oct 13, 2026
Merged

octonato merged 1 commit into
mainfrom
docs/readiness-review-wording

Conversation

@JustinPihony

Copy link
Copy Markdown
Contributor

Problem

The production readiness pages use "walk" in several senses ("Walk this page", "walks the sizing exercise", "scenarios walked end-to-end"). The word is informal and reads differently in each place. The agentic AI and Optimize pages in review use "review" instead.

Change

Replace "walk" with the verb that fits each sentence, in the index, the three checklists, and the two disaster recovery pages:

  • review: "Review this page before going live", "Your FDE reviews the principal items with you", "review failure scenarios", "scenarios reviewed end-to-end", "Review the alert list", "the readiness review"
  • run: "FDE runs the sizing exercise", "Running a real recovery end-to-end"
  • covered: "Not covered in detail at the tabletop"
  • "the detailed reference for the tabletop" replaces "the tabletop walks through"

Not changed

The Shared Responsibility Model and RACI rows "Akka walks the customer through console, CLI, and ticketing flows". The RACI pages are generated, and the sentence there means guiding the customer, so it is a separate edit.

Notes for review

Test plan

  • docs/bin/vale.sh on the changed pages, 0 errors, warnings and suggestions
  • Docs only, no code changes

@github-actions github-actions Bot added the documentation documentation related label Oct 13, 2026
@JustinPihony
JustinPihony marked this pull request as ready for review October 13, 2026 05:29
@octonato
octonato merged commit 5f46c10 into main Oct 13, 2026
11 checks passed
@octonato
octonato deleted the docs/readiness-review-wording branch October 13, 2026 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants