Skip to content

docs: drop the hype words from the mirrored CLI pages - #343

Merged
adnaan merged 1 commit into
mainfrom
voice
Aug 15, 2026
Merged

docs: drop the hype words from the mirrored CLI pages#343
adnaan merged 1 commit into
mainfrom
voice

Conversation

@adnaan

@adnaan adnaan commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

These four files mirror to /cli on the docs site, which now has a written voice — VOICE.md, added in livetemplate/docs#137. The docs-native pages were audited against it and came out clean. These did not.

What changed

comprehensive appeared five times and told a reader nothing. A test suite either covers the flows or it doesn't, so the text now says which:

  • "generates comprehensive E2E tests using chromedp that test all auth flows" → "generates E2E tests using chromedp that cover every auth flow"
  • "Each generated resource includes comprehensive tests." → "Each generated resource comes with tests."
  • "A comprehensive e2e testing framework … that reduces boilerplate by 85-90%" → "An e2e testing framework … It cuts test boilerplate by 85-90%."

**Production-ready security** (HTTP-only, secure, SameSite cookies) became **Secure session cookies** (HTTP-only, Secure, SameSite) — the parenthetical was already the real claim.

Rich content popoversContent popovers. And one nominalization: "allows you to customize templates project-wide" → "lets you customize templates across the whole project".

Left alone

Headings. Title Case is these documents' own convention, consistently applied across ~90 headings. Changing them is a rename, not a copy edit, and it would bury the actual fix in churn. Worth doing separately if you want it.

Verification

0 .go files touched — the diff is 4 markdown files. The repo's pre-commit hook (gofmt, golangci-lint, go test) ran and passed.

🤖 Generated with Claude Code

https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ

These four files mirror to /cli on the docs site, which now has a written voice
(livetemplate/docs VOICE.md). The docs-native pages were audited against it and
came out clean; these did not.

"comprehensive" appeared five times and told a reader nothing — a test suite is
either covering the flows or it isn't, so say which. "Production-ready security"
became the list of cookie flags it was actually describing. "Rich content
popovers" became "Content popovers".

Headings are left alone. Title Case is these documents' own convention and
changing ~90 of them is a rename, not a copy edit.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ
@claude

claude Bot commented Aug 15, 2026

Copy link
Copy Markdown

Reviewed — this is a small, low-risk copy edit across 4 markdown files (0 .go files touched), so most of the standard checklist (perf, security, tests) doesn't really apply. A few notes:

Discrepancy vs. the PR description
The description says headings were left alone ("Title Case is these documents' own convention... changing them is a rename, not a copy edit"), but testing/README.md does change a heading: ### Comprehensive Loggers### Loggers. It's harmless on its own — "Loggers" is still Title Case and consistent with the file's other ### headings — but it contradicts the stated scope. Worth either fixing the description or reverting that one hunk to match what's claimed.

Wording changes look accurate

  • Spot-checked "Rich content popovers" → "Content popovers": Popover.Content (components/popover/options.go) is just a plain string field with no special "rich"/HTML handling that the old wording was uniquely describing, so dropping "Rich" doesn't lose information.
  • "Production-ready security (HTTP-only, secure, SameSite cookies)" → "Secure session cookies (HTTP-only, Secure, SameSite)" is arguably more precise — capitalizing Secure matches the actual cookie attribute name rather than describing it as a vague quality.
  • "Each generated resource includes comprehensive tests." → "Each generated resource comes with tests." is consistent with the nearby feature-list line ("Generated tests covering each flow") — no factual claim is lost, just the filler adjective.

Nit
docs/guides/lvt-cli-guide.md's new bullet "Generated tests covering each flow" reads slightly awkwardly sitting in a list of noun-phrase features (CRUD operations, Search across string fields, ...) — a shorter "Tests for each flow" would match the list's rhythm better, but this is a style nit, not a blocker.

Overall: solid, well-scoped edit. Only the one heading/description mismatch is worth resolving before merge.

@adnaan
adnaan merged commit 08914ed into main Aug 15, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant