docs: improve README SEO for AI gateway discoverability#140
docs: improve README SEO for AI gateway discoverability#140SantiagoDePolonia merged 3 commits intomainfrom
Conversation
Add Docker Pulls and Go Version badges, rename section headers to include target keywords (AI Gateway, OpenAI-Compatible, LLM Providers, Gateway Configuration), and add a Community section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME.md updated: sections renamed and reorganized, badges for Docker Pulls and Go version added, Quick Start expanded with docker run examples and credential guidance, Supported Providers and API Endpoints reframed, Gateway Configuration updated, Community section added, and minor formatting tweaks. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new runtime control flow) Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
23-31:⚠️ Potential issue | 🟡 MinorDocument the Linux caveat for the Ollama example.
host.docker.internalworks on Docker Desktop, but it is not reliably available on Linux. As written, this quick-start path can fail for Linux users trying a local Ollama instance.Suggested doc tweak
docker run --rm -p 8080:8080 \ -e OPENAI_API_KEY="your-openai-key" \ -e ANTHROPIC_API_KEY="your-anthropic-key" \ -e GEMINI_API_KEY="your-gemini-key" \ -e GROQ_API_KEY="your-groq-key" \ -e XAI_API_KEY="your-xai-key" \ -e OLLAMA_BASE_URL="http://host.docker.internal:11434/v1" \ enterpilot/gomodel
+For Linux,
host.docker.internalmay require--add-host=host.docker.internal:host-gatewayor another host-reachable address.</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 23 - 31, Update the README's Docker quick-start
snippet to document the Linux caveat: note that host.docker.internal is not
always available on Linux and instruct Linux users to run the docker command
with an alternative host mapping (for example adding
--add-host=host.docker.internal:host-gateway or using the host's reachable IP)
so a local Ollama instance at OLLAMA_BASE_URL will be reachable; add this note
adjacent to the provided docker run example and include the suggested flag usage
as the recommended workaround.</details> </blockquote></details> </blockquote></details>🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed. Inline comments: In `@README.md`: - Around line 145-147: Update the "Gateway Configuration" section to point at the canonical config file: change the prose reference from `config.yaml` to `config/config.yaml` and update the existing link that currently targets `config/config.example.yaml` so it points to `config/config.yaml` (while still mentioning `.env.template` for env vars). Ensure the heading text and the sentence "See `.env.template` and `config/config.example.yaml`" are edited to read "See `.env.template` and `config/config.yaml`" so readers are directed to the authoritative configuration schema. --- Outside diff comments: In `@README.md`: - Around line 23-31: Update the README's Docker quick-start snippet to document the Linux caveat: note that host.docker.internal is not always available on Linux and instruct Linux users to run the docker command with an alternative host mapping (for example adding --add-host=host.docker.internal:host-gateway or using the host's reachable IP) so a local Ollama instance at OLLAMA_BASE_URL will be reachable; add this note adjacent to the provided docker run example and include the suggested flag usage as the recommended workaround.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
147-147:⚠️ Potential issue | 🟡 MinorPoint to the canonical config file, not the example.
The documentation references
config/config.example.yaml, but according to learnings, the canonical configuration file isconfig/config.yaml. Readers should be directed to the authoritative schema.📝 Proposed fix to reference the canonical config file
-GOModel is configured through environment variables and an optional `config.yaml`. Environment variables override YAML values. See [`.env.template`](.env.template) and [`config/config.example.yaml`](config/config.example.yaml) for the available options. +GOModel is configured through environment variables and an optional `config/config.yaml`. Environment variables override YAML values. See [`.env.template`](.env.template) and [`config/config.yaml`](config/config.yaml) for the available options.Based on learnings: Configuration must follow
.env.templateandconfig/config.yamlstructure with environment variables for server, storage, audit logging, usage tracking, cache, HTTP client, resilience, metrics, guardrails, and provider settings.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 147, Update the README sentence that currently points to `config/config.example.yaml` to reference the canonical configuration file `config/config.yaml`; specifically change the line mentioning "See `.env.template` and `config/config.example.yaml`" so it reads "See `.env.template` and `config/config.yaml`" and ensure any surrounding text still communicates that environment variables override YAML values and that `config/config.yaml` is the authoritative schema for server, storage, audit logging, usage tracking, cache, HTTP client, resilience, metrics, guardrails, and provider settings.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 7: The Go Version badge markdown currently links to a relative path
"(go.mod)"; update that link to the full GitHub URL for the go.mod file (e.g.,
"https://github.com/ENTERPILOT/GOModel/blob/main/go.mod") so the badge resolves
correctly when the README is viewed, keeping the badge text and image URL ([])
unchanged.
---
Duplicate comments:
In `@README.md`:
- Line 147: Update the README sentence that currently points to
`config/config.example.yaml` to reference the canonical configuration file
`config/config.yaml`; specifically change the line mentioning "See
`.env.template` and `config/config.example.yaml`" so it reads "See
`.env.template` and `config/config.yaml`" and ensure any surrounding text still
communicates that environment variables override YAML values and that
`config/config.yaml` is the authoritative schema for server, storage, audit
logging, usage tracking, cache, HTTP client, resilience, metrics, guardrails,
and provider settings.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit