docs(readme): add Grok to supported provider list#4230
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
| - [Getting started](./docs/getting-started/quick-start.md) | ||
| - [Architecture overview](./docs/architecture/overview.md) | ||
| - [Provider guides](./docs/providers/codex.md) | ||
| - [Grok provider](./docs/providers/grok.md) |
There was a problem hiding this comment.
🟡 Medium README.md:60
The new [Grok provider](./docs/providers/grok.md) link in the Documentation section points to a file that does not exist in the repository, so it returns a 404 instead of provider documentation. Add the missing docs/providers/grok.md file or remove the link until the page is available.
🤖 Copy this AI Prompt to have your agent fix this:
In file @README.md around line 60:
The new `[Grok provider](./docs/providers/grok.md)` link in the Documentation section points to a file that does not exist in the repository, so it returns a 404 instead of provider documentation. Add the missing `docs/providers/grok.md` file or remove the link until the page is available.
ApprovabilityVerdict: Approved Documentation-only change adding Grok to the supported providers list in README.md. No code or runtime impact. The unresolved comment about a broken link appears to be a false positive - the file doesn't contain the link mentioned. You can customize Macroscope's approvability policy. Learn more. |
0e6d67f to
4697696
Compare
4697696 to
c2b1476
Compare
What changed
Updated README.md to list Grok as a supported provider alongside Codex, Claude, Cursor, and OpenCode. Added the Grok CLI install/auth line and a link to the Grok provider docs.
Why
Grok is already fully supported in the codebase (provider driver, adapter, text generation, UI icons, settings, tests). The README was the only place missing it, which is misleading for new users.
Note
Low Risk
Documentation-only README edits with no runtime or security impact.
Overview
README now lists Grok as a supported coding agent alongside Codex, Claude, Cursor, and OpenCode in the opening blurb and the installation warning.
The install callout adds a Grok bullet with a link to the Grok CLI and the
grok loginauth step, matching how other providers are documented.Reviewed by Cursor Bugbot for commit c2b1476. Bugbot is set up for automated code reviews on this repo. Configure here.
Note
Add Grok to supported provider list in README
Updates README.md to include Grok in two provider support mentions and adds a Grok CLI installation and authentication bullet.
Macroscope summarized c2b1476.