Skip to content

docs: simplify CLI documentation language#896

Merged
ryanfowler merged 1 commit into
mainfrom
docs/simplified-technical-english
Jul 21, 2026
Merged

docs: simplify CLI documentation language#896
ryanfowler merged 1 commit into
mainfrom
docs/simplified-technical-english

Conversation

@ryanfowler

Copy link
Copy Markdown
Owner

Summary

  • revise CLI documentation to use shorter, active sentences and direct instructions
  • improve terminology and structure across the README and user guides
  • clarify that automatic uncompressed SSE retries apply only to GET and HEAD requests

Validation

  • prettier -w README.md docs/**/*.md
  • local Markdown link check
  • git diff --check

Cargo tests were not run because these changes affect documentation only.

Use shorter, active sentences and direct instructions throughout the CLI guides. Clarify automatic SSE retry behavior for safe and unsafe HTTP methods.
@ryanfowler
ryanfowler enabled auto-merge July 21, 2026 14:32
@ryanfowler
ryanfowler merged commit de2a0cb into main Jul 21, 2026
4 checks passed
@ryanfowler
ryanfowler deleted the docs/simplified-technical-english branch July 21, 2026 14:35
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