docs: refresh READMEs + website/docs for /.env + runners/transport restructure#167
Merged
KailasMahavarkar merged 1 commit intomainfrom Apr 20, 2026
Merged
Conversation
After #163 (.env + typed env.py) and #164 (env_key pointer in provider config), the autoresearch README still documented the old "inline api_key in config.json" shape. Updated: * Config example now shows env_key pointers (ollama_key, openrouter_key) instead of api_key strings * Added a short preamble explaining that secrets live in /.env and config.json is shape-only * Setup section now tells the user to copy both config.example.json AND .env.example, and edit /.env for real keys * "Add a new model" section points at env.py + .env.example for provider-level onboarding Other README.md files in the repo were scanned; only this one had stale config refs. Nothing else needs updating. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
KailasMahavarkar
force-pushed
the
docs/update-autoresearch-readme-env
branch
from
f74c86d to
726997d
Compare
KailasMahavarkar
changed the title
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
1 participant
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.
Summary
After #163 (
.env+ typedenv.py) and #164 (env_keypointer in provider config), the autoresearch README still documented the old "inline api_key in config.json" shape. Updated to match current reality.Changes in tools/autoresearch/README.md
env_keypointers (ollama_key,openrouter_key) instead of literalapi_keystrings/.envandconfig.jsonis shape-onlyconfig.example.jsonAND.env.example, then edit/.envfor real keysenv.py+.env.examplefor provider-level onboardingScope check
Scanned every README.md in the repo (root, framework, algos, playground, website, autoresearch). Only the autoresearch one had stale config refs. Nothing else needs updating.
🤖 Generated with Claude Code