Skip to content

docs(readme): add Grok to supported provider list#4230

Open
ashraftown wants to merge 1 commit into
pingdotgg:mainfrom
ashraftown:docs/add-grok-provider-to-readme
Open

docs(readme): add Grok to supported provider list#4230
ashraftown wants to merge 1 commit into
pingdotgg:mainfrom
ashraftown:docs/add-grok-provider-to-readme

Conversation

@ashraftown

@ashraftown ashraftown commented Jul 21, 2026

Copy link
Copy Markdown

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 login auth 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.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c464e082-3f56-4b43-9fff-0142495f6a8a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added size:XS 0-9 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list. labels Jul 21, 2026
Comment thread README.md Outdated
- [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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.

Comment thread README.md Outdated
@macroscopeapp

macroscopeapp Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Approvability

Verdict: 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.

@ashraftown
ashraftown force-pushed the docs/add-grok-provider-to-readme branch from 0e6d67f to 4697696 Compare July 21, 2026 11:32
@ashraftown
ashraftown force-pushed the docs/add-grok-provider-to-readme branch from 4697696 to c2b1476 Compare July 21, 2026 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS 0-9 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant