Skip to content

docs: fix README config examples and setup instructions - #472

Open
pfaffenfacundo-max wants to merge 1 commit into
BeehiveInnovations:mainfrom
pfaffenfacundo-max:main
Open

docs: fix README config examples and setup instructions#472
pfaffenfacundo-max wants to merge 1 commit into
BeehiveInnovations:mainfrom
pfaffenfacundo-max:main

Conversation

@pfaffenfacundo-max

Copy link
Copy Markdown

Summary

  • Fix invalid JSON in config examples (remove // comments that break strict JSON parsers)
  • Add Windows PowerShell setup step (run-server.ps1) alongside the bash quick start
  • Align stated Python requirement with pyproject.toml (3.9+, was documented as 3.10+)
  • List clink under "Enabled by default" tools (it's registered and enabled but was missing from that list)
  • Clarify guidance on combining provider API keys (pick one unified gateway — OpenRouter or DIAL — rather than mixing both)

Test plan

  • Validated all json code fences in README.md parse with json.loads
  • Manual read-through comparing README claims against server.py, .env.example, and pyproject.toml

🤖 Generated with Claude Code

Correct invalid JSON (remove // comments), add Windows PowerShell
setup step, align Python version with pyproject.toml (3.9+), list
clink among default-enabled tools, and clarify provider gateway guidance.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Repo admins can enable using credits for code reviews in their settings.

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