Skip to content

docs fixes#2392

Merged
akshaydeo merged 1 commit intomainfrom
03-30-docs_fixes
Mar 30, 2026
Merged

docs fixes#2392
akshaydeo merged 1 commit intomainfrom
03-30-docs_fixes

Conversation

@akshaydeo
Copy link
Copy Markdown
Contributor

@akshaydeo akshaydeo commented Mar 30, 2026

Summary

Updates Claude Code documentation to clarify that API keys are always required when using custom base URLs like Bifrost, even for OAuth-based authentication methods. Adds new images for Google Workspace user provisioning setup.

Changes

  • Clarified that ANTHROPIC_API_KEY is required when routing through custom base URLs, even for Pro/Max/Teams accounts using OAuth
  • Added ANTHROPIC_AUTH_TOKEN environment variable setup alongside ANTHROPIC_API_KEY in configuration examples
  • Updated authentication precedence documentation to note that ANTHROPIC_API_KEY is always required with custom base URLs
  • Added five new PNG images for Google Workspace user provisioning documentation

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (Next.js)
  • Docs

How to test

Verify the documentation renders correctly and the new environment variable examples work as expected:

# Test the updated configuration
export ANTHROPIC_API_KEY=your-bifrost-virtual-key
export ANTHROPIC_AUTH_TOKEN=your-bifrost-virtual-key
export ANTHROPIC_BASE_URL=http://localhost:8080/anthropic

# Verify Claude Code can authenticate with these settings
claude-code --help

The new environment variables ANTHROPIC_API_KEY and ANTHROPIC_AUTH_TOKEN are now documented as required when using custom base URLs, even for OAuth authentication flows.

Screenshots/Recordings

Added new images for Google Workspace setup:

  • gws-auth-client-creation.png
  • gws-connection-status.png
  • gws-domain-wide-delegation.png
  • gws-service-account-id.png
  • gws-service-key-creation.png

Breaking changes

  • Yes
  • No

Related issues

Security considerations

The documentation now properly emphasizes that API keys are required for custom base URL configurations, ensuring users understand the authentication requirements for secure Bifrost integration.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 30, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cb3c91df-696a-4542-bd70-a9f113b1d1bf

📥 Commits

Reviewing files that changed from the base of the PR and between dd314d0 and 04a0ae5.

⛔ Files ignored due to path filters (5)
  • docs/media/user-provisioning/gws-auth-client-creation.png is excluded by !**/*.png
  • docs/media/user-provisioning/gws-connection-status.png is excluded by !**/*.png
  • docs/media/user-provisioning/gws-domain-wide-delegation.png is excluded by !**/*.png
  • docs/media/user-provisioning/gws-service-account-id.png is excluded by !**/*.png
  • docs/media/user-provisioning/gws-service-key-creation.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/cli-agents/claude-code.mdx

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Clarified that an API key is required for Claude Code even when using a custom Bifrost base URL
    • Updated environment variable setup instructions for OAuth flows (Pro/Max and Teams/Enterprise scenarios)
    • Enhanced authentication guidance to clarify API key requirements with custom authentication
    • Improved example configurations to indicate required environment variables

Walkthrough

Updated documentation for Claude Code authentication configuration, clarifying that an API key remains required when using a custom Bifrost base URL. Modified OAuth setup sections to replace Bifrost URL configuration steps with explicit environment variable guidance, and added precedence notes for API key handling in custom authentication scenarios.

Changes

Cohort / File(s) Summary
Documentation Update
docs/cli-agents/claude-code.mdx
Clarified API key requirements for custom Bifrost configurations across Pro/Max and Teams/Enterprise OAuth flows. Replaced Bifrost URL setup step with environment variable exports (ANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN). Added note about dummy/virtual-key requirements and extended precedence guidance for custom authentication scenarios.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hop, hop, hooray! The docs now shine so clear,
With API keys dancing near and far,
No more confusion with Bifrost in the air,
Authentication flows now plain to see,
Virtual keys and tokens all aligned—
What splendid clarity we find! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 03-30-docs_fixes

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

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@akshaydeo akshaydeo marked this pull request as ready for review March 30, 2026 12:02
Copy link
Copy Markdown
Contributor Author

akshaydeo commented Mar 30, 2026

Merge activity

  • Mar 30, 12:02 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Mar 30, 12:03 PM UTC: @akshaydeo merged this pull request with Graphite.

@github-actions
Copy link
Copy Markdown
Contributor

🧪 Test Suite Available

This PR can be tested by a repository admin.

Run tests for PR #2392

@akshaydeo akshaydeo merged commit 63db574 into main Mar 30, 2026
18 of 20 checks passed
@akshaydeo akshaydeo deleted the 03-30-docs_fixes branch March 30, 2026 12:03
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 30, 2026

Confidence Score: 5/5

Pure documentation fix — no code changes, safe to merge

All changes are documentation-only. The clarifications are accurate and consistent with the existing API key behavior described in the codebase. The only finding is a very minor comment-wording suggestion (P2). The new GWS images follow the established pattern in the docs/media/user-provisioning/ directory.

No files require special attention

Important Files Changed

Filename Overview
docs/cli-agents/claude-code.mdx Documentation fixes clarifying that ANTHROPIC_API_KEY (and ANTHROPIC_AUTH_TOKEN) are always required when using a custom ANTHROPIC_BASE_URL, even for OAuth-based Pro/Max/Teams/Enterprise users
docs/media/user-provisioning/gws-auth-client-creation.png New screenshot asset for a forthcoming Google Workspace user provisioning guide; follows the same pattern as existing Entra/Okta provisioning images in this directory
docs/media/user-provisioning/gws-service-key-creation.png New screenshot asset (service key creation) for forthcoming GWS provisioning docs

Reviews (1): Last reviewed commit: "docs fixes" | Re-trigger Greptile

1. **Set environment variables**
```bash
export ANTHROPIC_API_KEY=your-bifrost-virtual-key # or "dummy" if virtual keys are not enabled
export ANTHROPIC_AUTH_TOKEN=your-bifrost-virtual-key # same value
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.

P2 # same value comment could be clearer

The comment # same value on the ANTHROPIC_AUTH_TOKEN line implicitly refers to the value on the ANTHROPIC_API_KEY line above, but doesn't remind the reader that "dummy" is also valid here when virtual keys are not enabled. A user who sets ANTHROPIC_AUTH_TOKEN without reading the previous line carefully might miss that nuance.

Consider making the comment more self-contained, e.g. # same value as ANTHROPIC_API_KEY (or "dummy"). The same applies at line 51 in the Teams/Enterprise section.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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.

2 participants