Skip to content

docs: fix streaming/auth/scope accuracy and scrub em-dashes#4

Merged
prasadus92 merged 1 commit into
mainfrom
docs/accuracy-and-style-cleanup
Jun 2, 2026
Merged

docs: fix streaming/auth/scope accuracy and scrub em-dashes#4
prasadus92 merged 1 commit into
mainfrom
docs/accuracy-and-style-cleanup

Conversation

@prasadus92
Copy link
Copy Markdown
Owner

Small docs/accuracy pass found while reviewing the repo after #3.

Corrections

  • README: streaming is supported on the OpenAI-compat route too (it streams via the same _stream_bytes path, and there's a streaming test on /openai/v1/chat/completions), not just Anthropic and Gemini. Also dropped the stale "~400 lines" figure (the package is now ~900 lines after streaming/metrics/auth/Docker additions).
  • CONTRIBUTING: the "intentionally does not authenticate incoming requests" scope note contradicted the shipped optional bearer-token auth (VERTEX_PROXY_API_KEY); reworded to reflect it's off by default but available. Also removed a reference to a tests/integration/ directory that does not exist.

Style

  • Scrubbed the remaining em-dashes from the README, CONTRIBUTING, the systemd example, and one code comment, matching the project's prose style.

No code or behavior changes. Suite: 22 passed, ruff check + format clean.

- README: streaming is supported on the OpenAI-compat route too, not just
  Anthropic and Gemini; drop the stale "~400 lines" figure.
- CONTRIBUTING: optional bearer-token auth (VERTEX_PROXY_API_KEY) exists,
  so the "intentionally does not authenticate" note was wrong; remove the
  reference to a tests/integration/ dir that does not exist.
- Scrub remaining em-dashes from README, CONTRIBUTING, the systemd example,
  and a code comment for consistency with the project's prose style.
@prasadus92 prasadus92 merged commit faed87c into main Jun 2, 2026
2 checks passed
@prasadus92 prasadus92 deleted the docs/accuracy-and-style-cleanup branch June 2, 2026 13:38
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