docs: remove infrastructure provider/cost mentions (Rule #7)#18
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates public documentation to remove infrastructure provider/free-tier signals (Rule #7) while keeping the setup/configuration guidance provider-neutral.
Changes:
- Adjust LLM provider wording to remove “OpenRouter” mentions and use OpenAI-compatible endpoint phrasing.
- Replace Redis REST/provider-specific env var examples with canonical
REDIS_URL. - Generalize “Upstash REST variables” references to “REST-style Redis variables” in architecture/roadmap docs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| SETUP_GUIDE.md | Updates LLM prerequisite wording and rewrites the .env examples to use REDIS_URL + provider-neutral LLM variables. |
| ARCHITECTURE.md | Generalizes the Redis legacy env var description to remove provider naming. |
| ROADMAP.md | Generalizes the effective_redis_url() note to remove provider naming. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+72
to
73
| - Vyrox supports OpenAI-compatible APIs (OpenAI, Anthropic, or any OpenAI-compatible endpoint) | ||
| - Configure the model via `LLM_MODEL` and the endpoint via `LLM_BASE_URL` |
| |---|---|---| | ||
| | `VYROX_HMAC_SECRET` | all | Sixty four hex characters. Signs Python ↔ Python and Python ↔ Rust traffic. | | ||
| | `REDIS_URL` | ingestion, worker | `redis://` or `rediss://` URL. The legacy Upstash REST variables are still accepted for backward compatibility but new deployments should set this. | | ||
| | `REDIS_URL` | ingestion, worker | `redis://` or `rediss://` URL. The legacy REST-style Redis variables are still accepted for backward compatibility but new deployments should set this. | |
Comment on lines
+63
to
64
| first and falls back to the legacy REST-style Redis variables. The | ||
| worker refuses to start with no Redis URL. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Scrubs infrastructure-provider and free-model leaks from the public docs per Rule #7 (no infra cost/provider/free-tier signals in public repos). Technical meaning is preserved throughout; canonical env vars are used.
Changes
SETUP_GUIDE.md
...or any OpenRouter-compatible endpointto...or any OpenAI-compatible endpoint.envRedis block: replacedUPSTASH_REDIS_REST_URL/UPSTASH_REDIS_REST_TOKENwith the canonicalREDIS_URL=redis://localhost:6379.envLLM block: replacedOPENROUTER_API_KEY+OPENROUTER_MODEL=mistralai/mistral-7b-instruct:free(free-model name) with provider-neutralOPENCODE_ZEN_API_KEY/LLM_BASE_URL/LLM_MODELplaceholders; section header# OpenRouter (LLM)to# LLM Provider (any OpenAI-compatible endpoint)ARCHITECTURE.md
REDIS_URLrow:legacy Upstash REST variablestolegacy REST-style Redis variablesROADMAP.md
effective_redis_url()note:legacy Upstash REST variablestolegacy REST-style Redis variablesNote:
src/*.mdandbook/are generated byscripts/build.shfrom these tracked top-level files, so only the source is edited; the build regenerates the rest. The legacyOPENROUTER_API_KEYvar name is retained where it documents an actual code env-var contract (it is a variable name, not a free-tier/cost signal).Docs-only. No source/logic changes.
🤖 Generated with Claude Code