Move AI workspace docs to root level - #416
Merged
Thushani-Jayasekera merged 5 commits intoAug 7, 2026
Merged
Conversation
|
Warning Review limit reached
Next review available in: 43 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughAdded the AI Workspace 1.0.0 documentation set. Added setup, authentication, resource, policy, secret, CI/CD, Insights, and SDK guides. Updated links, metadata, navigation, redirects, and version configuration. ChangesAI Workspace documentation release
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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 |
Krishanx92
previously approved these changes
Aug 7, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 44
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/ai-gateway/next/quick-start-guide.md`:
- Line 19: Update the introduction near the guide’s opening to define LLM at
first use as “large language model (LLM)”. Split the existing long sentence into
concise, direct sentences, ensuring each remains under 26 words while preserving
the guide’s scope and audience.
- Around line 196-201: Rewrite the governance section in short, direct,
active-voice sentences. Replace indirect phrases such as “doesn't have to run
alone,” “the way this guide does,” and “show up” with concise declarative
wording while preserving the top-down and bottom-up workflows, synchronization
behavior, and existing links.
In `@en/docs/ai-workspace/1.0.0/ai-gateways/setting-up.md`:
- Around line 103-105: Use one tested AI Gateway release consistently across all
referenced sites: in en/docs/ai-workspace/1.0.0/ai-gateways/setting-up.md lines
103-105 and 167-169, match each download URL with its unzip archive filename; at
lines 217-227, align the download version and setup directory with that release;
and in en/docs/ai-workspace/1.0.0/about-this-release.md lines 203-210, update
the compatibility entry to the same version.
In `@en/docs/ai-workspace/1.0.0/ci-cd/configure-ci-cd-workflow.md`:
- Around line 29-79: Add a subsection heading, such as “Configure the gateway
connection,” immediately before the gateway setup procedure beginning with
“Configure and select the gateway connection.” Keep the existing AI Workspace
heading and gateway commands unchanged.
- Around line 276-305: Update the “Use environment-specific values” section to
document how gateway apply resolves ENV_CLI_* placeholders when invoked with its
runtime.yaml workflow. Specify whether it uses the project .env file and process
environment without --env-file; if not, document the gateway-specific option
required to provide these values so placeholders resolve before deployment.
In `@en/docs/ai-workspace/1.0.0/configure-inbound-auth.md`:
- Around line 55-56: Update the note’s inline code span to use `Bearer` without
trailing whitespace, and describe it as a prefix in surrounding prose while
preserving the existing authentication behavior.
- Line 53: Update the documentation guidance around the Authorization header to
distinguish API-key and bearer-token authentication. State that API-key
authentication should use the provider-specific api-key header, including Azure
OpenAI, while Authorization: Bearer applies only to managed-identity/token
authentication; remove the claim that these SDKs work without additional header
setup for the API-key configuration.
In `@en/docs/ai-workspace/1.0.0/getting-started.md`:
- Around line 124-138: Update the manual-rotation guidance near “To rotate a
single value by hand” to exclude both encryption-key files under resources/keys.
Direct readers to use --rotate-encryption-key for encryption-key rotation, while
retaining deletion guidance only for non-encryption artifacts and preserving the
existing destructive warning.
- Around line 21-25: Rewrite the prerequisite list in the getting-started guide
so every item is a concise imperative action, including installing
Docker/Compose, ensuring ports 9643 and 9243 are available, and installing curl
and unzip. Add terminal punctuation consistently while preserving the existing
port-reference link.
In `@en/docs/ai-workspace/1.0.0/insights.md`:
- Line 17: Update the description adjacent to the Insights page link to remove
the capability-marketing phrase “AI-native” and directly describe Moesif as the
external analytics service that stores and displays the analytics data.
In `@en/docs/ai-workspace/1.0.0/llm-provider-templates/configure-template.md`:
- Line 23: Update the prerequisite item in the LLM provider template
documentation by adding a period after “service,” matching the terminal
punctuation used by the other list items.
In `@en/docs/ai-workspace/1.0.0/llm-provider-templates/manage-template.md`:
- Line 40: Update the linked tab labels in the template editing instruction so
Overview, Connection, and Token Mapping are each bolded as UI element names,
while preserving the existing link destination and surrounding text.
In `@en/docs/ai-workspace/1.0.0/llm-provider-templates/overview.md`:
- Around line 15-17: Define each acronym or initialism at its first use across
all listed sites: in
en/docs/ai-workspace/1.0.0/llm-provider-templates/overview.md lines 15-17 define
LLM; configure-template.md lines 15-23 define LLM and URL; manage-template.md
lines 15-21 define LLM; policies/build-gateway-with-ai-policies.md lines 19-21
define CLI and CI/CD; policies/overview.md lines 68, 91, 111, 176, and 275
define JSON, API, USD, IETF, and CORS respectively;
policies/writing-an-ai-policy.md lines 20-25 define SDK, JSON, and SSE;
secrets-management.md line 18 use the verified full encryption algorithm name
and line 52 define API; mcp-proxies/apply-policies.md lines 16-20 and 28-30
define MCP and JSON-RPC; policies/apply-ai-policies-to-proxies.md lines 17 and
50-51 define LLM, MCP, and N/A. Use the full term followed by the abbreviation
in parentheses, while preserving subsequent abbreviated usage.
In `@en/docs/ai-workspace/1.0.0/llm-providers/configure-provider.md`:
- Line 36: Remove temporal “new” terminology at all specified sites: rename the
heading in en/docs/ai-workspace/1.0.0/llm-providers/configure-provider.md:36-36
to “Add a provider”; change the token wording in
en/docs/ai-workspace/1.0.0/ai-gateways/setting-up.md:78-78 to “replacement
token” and at :197-197 and :266-266 to “replacement registration token”; rename
the heading in en/docs/ai-workspace/1.0.0/llm-proxies/configure-proxy.md:38-38
to “Create an App LLM proxy”.
In `@en/docs/ai-workspace/1.0.0/llm-proxies/configure-proxy.md`:
- Around line 125-133: Update both URL examples near the proxy endpoint
documentation to use the repository’s indented code-block format instead of
untagged fenced blocks. Preserve the example URLs and surrounding explanation
unchanged.
In `@en/docs/ai-workspace/1.0.0/llm-proxies/manage-proxy.md`:
- Around line 106-117: Keep the authentication procedure in the ordered list by
indenting the authentication settings table beneath step 2, or restart the final
item as a new ordered list beginning with 1. Ensure markdownlint-cli2 recognizes
the sequence as valid while preserving the rendered procedure.
In `@en/docs/ai-workspace/1.0.0/mcp-proxies/configure-proxy.md`:
- Around line 2-3: Update the documentation’s first occurrences of MCP, URL, ID,
and API to use their full terms followed by the abbreviations: Model Context
Protocol (MCP), Uniform Resource Locator (URL), identifier (ID), and application
programming interface (API). Apply these expansions consistently at the
referenced uses while leaving subsequent acronym-only references unchanged.
- Around line 102-104: Update the fenced URL code block in
en/docs/ai-workspace/1.0.0/mcp-proxies/configure-proxy.md at lines 102-104 and
the Invoke URL code block in en/docs/ai-workspace/1.0.0/using-sdks.md at lines
38-40 to include the text language identifier after each opening fence,
preserving the existing block contents.
- Line 24: Update the role requirement list item to bold both UI role labels,
**Admin** and **Developer**, and terminate the sentence with a period.
In `@en/docs/ai-workspace/1.0.0/mcp-proxies/overview.md`:
- Around line 2-3: Update the MCP proxies overview text to expand AI, HTTP, and
JSON-RPC at their first occurrences, including the referenced lines, and split
the sentence at line 19 into complete sentences of fewer than 26 words while
preserving the original meaning.
In `@en/docs/ai-workspace/1.0.0/overview.md`:
- Line 60: Update the “AI Gateways” heading in the documentation to sentence
case as “AI gateways,” preserving the existing heading level and content.
In `@en/docs/ai-workspace/1.0.0/policies/apply-ai-policies-to-proxies.md`:
- Around line 92-95: Update the policy documentation wording: replace “Global
Guardrails/Global Policies — applies” with “Global Guardrails or Global
Policies—apply,” and replace “**Add**/**Submit**” with “**Add** or **Submit**,”
preserving the surrounding instructions.
In `@en/docs/ai-workspace/1.0.0/policies/build-gateway-with-ai-policies.md`:
- Around line 126-142: Correct the directory tree example so my-ai-gateway and
my-ai-policy are sibling directories under a shared parent, matching the
relative filePath ../my-ai-policy used in build.yaml. Keep the policy files and
configuration example unchanged.
In `@en/docs/ai-workspace/1.0.0/policies/overview.md`:
- Line 91: Update the documentation sentences at the referenced policy overview
locations to keep every sentence under 26 words. Split each long sentence into
short, declarative sentences while preserving the existing meaning, links, and
guidance.
- Line 110: Update the LLM cost table entry in the policy overview so the em
dash has no surrounding spaces, changing “Nothing on its own — calculates” to
“Nothing on its own—calculates” while preserving the rest of the text.
In `@en/docs/ai-workspace/1.0.0/policies/writing-an-ai-policy.md`:
- Line 82: Update the directory reference in the policy documentation sentence
to format policies as inline code using backticks, while preserving the existing
wording and meaning.
- Around line 98-112: Update the Go examples centered on MyAIPolicy and
GetPolicy so they compile as a single example: add the blockThreshold field to
MyAIPolicy with the type expected by GetPolicy, and import the bytes and fmt
packages used by the example. Preserve the existing policy behavior and
initialization flow.
In `@en/docs/ai-workspace/1.0.0/secrets-management.md`:
- Around line 33-37: Add blank lines immediately after each {% raw %} tag and
immediately before each {% endraw %} tag surrounding the fenced code blocks in
the secrets-management documentation, including the referenced additional
blocks, while preserving their existing content.
In `@en/docs/ai-workspace/1.0.0/setting-up/authentication/asgardeo-setup.md`:
- Line 23: Update the register_asgardeo_scopes.sh prerequisite and Step 4
download flow to fetch a pinned release tag or commit instead of mutable main,
fail on HTTP errors, and verify the published checksum or signature before
execution. Ensure ./register_asgardeo_scopes.sh runs only after all verification
succeeds, while preserving the existing ASGARDEO_CLIENT_SECRET usage.
- Around line 149-160: Update the authentication setup guidance to remove the
recommendation to store the OIDC client secret in shared api-platform.env.
Direct users to an AI Workspace-specific environment file, or make the mounted
secret-file configuration the default production procedure, while preserving the
existing secret-file path and fail-closed behavior.
In
`@en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md`:
- Around line 142-147: Make the OIDC redirect URL configuration consistent
across
en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md
lines 142-147 and en/docs/ai-workspace/1.0.0/setting-up/ports.md lines 125-126:
either replace the literal redirect_url and post_logout_redirect_url values with
the documented environment interpolation tokens and verify the shipped
configuration uses them, or update the ports guidance to instruct readers to
edit the literal URLs directly.
- Line 3: Shorten the front-matter description in
en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md
(line 3) to under 158 characters while preserving the OIDC product, task, and
configuration terms; also shorten the interpolation and secret-management
description in en/docs/ai-workspace/1.0.0/setting-up/configuration.md (line 3)
and the database migration and TLS description in
en/docs/ai-workspace/1.0.0/setting-up/database.md (line 3) to the same limit.
- Line 46: Remove the spaces surrounding each em dash in the prose at
en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md
lines 46-46 and 76-76; en/docs/ai-workspace/1.0.0/setting-up/configuration.md
lines 28-28 and 71-71; en/docs/ai-workspace/1.0.0/setting-up/database.md lines
28-28 and 145-145; en/docs/ai-workspace/1.0.0/setting-up/ports.md line 115-115;
and en/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.md line 67-67. No
other content changes are needed.
- Around line 98-102: Update the issuer and authority URL examples to use the
identity provider’s issuer/authority base URL rather than the /oauth2/token
endpoint. In
en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md
lines 98-102, correct the issuer value in the platform_api.auth.idp example;
apply the corresponding authority correction at lines 142-147. Ensure the issuer
matches the token’s iss claim and the authority supports
/.well-known/openid-configuration.
In `@en/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.md`:
- Around line 297-299: Add a prominent warning to the “Step 13: Verify the
access token” section advising readers never to paste production access tokens
into jwt.ms or other web services, since they are sensitive bearer credentials;
recommend using a local decoder or disposable test token and avoiding
browser-history retention.
- Around line 163-169: Update the “Step 7: Add optional claims” instructions to
remove `tid` and `oid` from the claims selected in the portal, leaving only
claims that require optional-claim configuration. Clarify that
`preferred_username` and `email` are provided through the existing `profile` and
`email` scopes.
In `@en/docs/ai-workspace/1.0.0/setting-up/database.md`:
- Around line 54-62: Update the PostgreSQL setup statements in the database
guide to revoke CREATE on the public schema from platform_api while connected as
an administrator to the platform_api database, before the existing USAGE grant.
Preserve the current database/user creation and connection permissions.
In `@en/docs/ai-workspace/1.0.0/setting-up/ports.md`:
- Around line 46-53: Qualify the host.docker.internal guidance in the ports.md
examples at lines 46-53 and 73-83: state that Docker Desktop on macOS and
Windows provides it automatically, while Linux requires a Compose extra_hosts
mapping using host-gateway or another reachable host address. Keep the
controlplane_host and control_plane.url distinction unchanged.
In `@en/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.md`:
- Around line 94-102: In the conventions list, add blank lines immediately
before and after the nested shell code fence containing the credential export
command, while keeping it associated with the **Auth** list item.
- Line 2: Update the document title and applicable heading to sentence case,
using “gateway-deployed” as the generic term and reserving “AI Gateway”
capitalization for the product name.
- Around line 156-159: Replace the copyable credentials and public endpoint in
en/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.md#L156-L159 with
clearly marked placeholders or test-only values, and add a warning not to commit
real credentials. Also replace the proxy authentication literal at `#L184-L186`
and MCP authentication literal at `#L213-L216` with placeholders; all three sites
require direct changes.
- Around line 47-53: Update the default [controller.controlplane] example so
insecure_skip_verify is false. Document enabling true only as a
local-development exception for a known self-signed certificate, without
changing the deployment_sync_enabled setting.
In `@en/docs/ai-workspace/1.0.0/using-sdks.md`:
- Around line 2-3: Update the title and description front matter in “Invoke
providers and proxies via SDKs” to spell out every acronym at its first
occurrence—artificial intelligence (AI), software development kit (SDK), large
language model (LLM), application programming interface (API), and uniform
resource locator (URL)—then use the abbreviations afterward where appropriate.
- Line 273: Update the SDK installation command in the “Install” example to pin
mistralai to the known-good version 2.4.5, while keeping the httpx dependency
unchanged.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: d6a62241-dd19-4735-8d15-7b4a199d65a4
📒 Files selected for processing (76)
en/docs/ai-gateway/next/llm-proxy/multi-provider-routing.mden/docs/ai-gateway/next/llm-proxy/quick-start-guide.mden/docs/ai-gateway/next/mcp-proxy/quick-start-guide.mden/docs/ai-gateway/next/quick-start-guide.mden/docs/ai-workspace/1.0.0/about-this-release.mden/docs/ai-workspace/1.0.0/ai-gateways/setting-up.mden/docs/ai-workspace/1.0.0/ci-cd/configure-ci-cd-workflow.mden/docs/ai-workspace/1.0.0/ci-cd/overview.mden/docs/ai-workspace/1.0.0/configure-inbound-auth.mden/docs/ai-workspace/1.0.0/genai-applications.mden/docs/ai-workspace/1.0.0/getting-started.mden/docs/ai-workspace/1.0.0/insights.mden/docs/ai-workspace/1.0.0/llm-provider-templates/configure-template.mden/docs/ai-workspace/1.0.0/llm-provider-templates/manage-template.mden/docs/ai-workspace/1.0.0/llm-provider-templates/overview.mden/docs/ai-workspace/1.0.0/llm-providers/configure-provider.mden/docs/ai-workspace/1.0.0/llm-providers/manage-provider.mden/docs/ai-workspace/1.0.0/llm-providers/overview.mden/docs/ai-workspace/1.0.0/llm-proxies/configure-proxy.mden/docs/ai-workspace/1.0.0/llm-proxies/manage-proxy.mden/docs/ai-workspace/1.0.0/llm-proxies/overview.mden/docs/ai-workspace/1.0.0/mcp-proxies/apply-policies.mden/docs/ai-workspace/1.0.0/mcp-proxies/configure-proxy.mden/docs/ai-workspace/1.0.0/mcp-proxies/overview.mden/docs/ai-workspace/1.0.0/overview.mden/docs/ai-workspace/1.0.0/policies/apply-ai-policies-to-proxies.mden/docs/ai-workspace/1.0.0/policies/build-gateway-with-ai-policies.mden/docs/ai-workspace/1.0.0/policies/overview.mden/docs/ai-workspace/1.0.0/policies/writing-an-ai-policy.mden/docs/ai-workspace/1.0.0/secrets-management.mden/docs/ai-workspace/1.0.0/setting-up/authentication/asgardeo-setup.mden/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.mden/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.mden/docs/ai-workspace/1.0.0/setting-up/authentication/overview.mden/docs/ai-workspace/1.0.0/setting-up/configuration.mden/docs/ai-workspace/1.0.0/setting-up/database.mden/docs/ai-workspace/1.0.0/setting-up/ports.mden/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.mden/docs/ai-workspace/1.0.0/using-sdks.mden/docs/ai-workspace/next/about-this-release.mden/docs/ai-workspace/next/ai-gateways/setting-up.mden/docs/ai-workspace/next/ci-cd/configure-ci-cd-workflow.mden/docs/ai-workspace/next/ci-cd/overview.mden/docs/ai-workspace/next/configure-inbound-auth.mden/docs/ai-workspace/next/genai-applications.mden/docs/ai-workspace/next/getting-started.mden/docs/ai-workspace/next/insights.mden/docs/ai-workspace/next/llm-provider-templates/configure-template.mden/docs/ai-workspace/next/llm-provider-templates/manage-template.mden/docs/ai-workspace/next/llm-provider-templates/overview.mden/docs/ai-workspace/next/llm-providers/configure-provider.mden/docs/ai-workspace/next/llm-providers/manage-provider.mden/docs/ai-workspace/next/llm-providers/overview.mden/docs/ai-workspace/next/llm-proxies/configure-proxy.mden/docs/ai-workspace/next/llm-proxies/manage-proxy.mden/docs/ai-workspace/next/llm-proxies/overview.mden/docs/ai-workspace/next/mcp-proxies/apply-policies.mden/docs/ai-workspace/next/mcp-proxies/configure-proxy.mden/docs/ai-workspace/next/mcp-proxies/overview.mden/docs/ai-workspace/next/overview.mden/docs/ai-workspace/next/policies/apply-ai-policies-to-proxies.mden/docs/ai-workspace/next/policies/build-gateway-with-ai-policies.mden/docs/ai-workspace/next/policies/overview.mden/docs/ai-workspace/next/policies/writing-an-ai-policy.mden/docs/ai-workspace/next/secrets-management.mden/docs/ai-workspace/next/setting-up/authentication/asgardeo-setup.mden/docs/ai-workspace/next/setting-up/authentication/connect-an-identity-provider.mden/docs/ai-workspace/next/setting-up/authentication/entra-id-setup.mden/docs/ai-workspace/next/setting-up/authentication/overview.mden/docs/ai-workspace/next/setting-up/configuration.mden/docs/ai-workspace/next/setting-up/database.mden/docs/ai-workspace/next/setting-up/ports.mden/docs/ai-workspace/next/sync-gateway-created-artifacts.mden/docs/ai-workspace/next/using-sdks.mden/docs/next/index.mden/mkdocs.yml
Contributor
Author
|
@CodeRabbit review |
|
Contributor
Author
|
@CodeRabbit review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 7
♻️ Duplicate comments (2)
en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md (1)
101-101: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winUse the issuer value from OIDC discovery.
The example sets
issuertohttps://idp.example.com/oauth2token. This is endpoint-shaped and does not match the authority example. A copied configuration fails unless the tokenissclaim has exactly this value.Use a placeholder for the issuer returned by
/.well-known/openid-configuration. The Platform API configuration template uses a base issuer example. (raw.githubusercontent.com)Proposed correction
-issuer = ["https://idp.example.com/oauth2token"] +issuer = ["<issuer-url-from-discovery>"]🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md` at line 101, Update the issuer example in the authentication configuration to use a base-issuer placeholder representing the issuer returned by OIDC discovery, rather than the endpoint-shaped /oauth2token URL. Keep the example aligned with the authority value used in the surrounding configuration and the Platform API template.en/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.md (1)
168-168: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winDo not require
preferred_usernameandThe application already requests the
profileandpreferred_usernamethroughprofile. TheKeep the scopes and state that
Proposed correction
-4. Add the `preferred_username` and `email` claims. Both also depend on the `profile` and `email` scopes, which the application requests already. +4. Keep the `profile` and `email` scopes in the application request. `preferred_username` requires `profile`, and `email` may be absent when the account has no email address.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.md` at line 168, Update the authentication setup step describing optional access-token claims: remove `preferred_username` and `email` from the required configuration instructions, retain the existing `profile` and `email` scope guidance, and state that the `email` claim may be absent. Reserve this step for claims that actually require optional-claim configuration.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/ai-workspace/1.0.0/policies/apply-ai-policies-to-proxies.md`:
- Line 93: Update the endpoint or capability card bullet in the documentation to
remove the spaces surrounding the em dash, preserving the existing wording and
punctuation.
In `@en/docs/ai-workspace/1.0.0/policies/overview.md`:
- Line 91: Split the provider-transformation introduction near the linked LLM
header router guidance into sentences under 26 words each. Preserve all existing
guidance, and place the Multi-provider routing link in its own sentence.
- Around line 110-111: Expand the first-use acronyms in both affected
documentation locations: in en/docs/ai-workspace/1.0.0/policies/overview.md
lines 110-111, change USD to “United States dollars (USD)”; in
en/docs/ai-workspace/1.0.0/secrets-management.md line 18, spell out the full
encryption algorithm name followed by “(AES-256-GCM)”.
In `@en/docs/ai-workspace/1.0.0/setting-up/authentication/asgardeo-setup.md`:
- Around line 69-75: Update the two ordered-list prefixes in the setup
instructions from 5. and 6. to 1., preserving their existing text and order.
In
`@en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md`:
- Line 76: Split the long documentation sentences so each sentence contains
fewer than 26 words and communicates one main idea. Update
en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md:76
by separating role-mode behavior, mapping configuration, and restart behavior;
en/docs/ai-workspace/1.0.0/getting-started.md:152 and setting-up/database.md:152
by separating token source, production guidance, and failure or startup
behavior; setting-up/database.md:64 by separating connection instructions from
PostgreSQL version context; setting-up/ports.md:83 by separating
platform-specific hostname behavior; setting-up/ports.md:115 by separating
reachability guidance from gateway failure behavior; and
sync-gateway-created-artifacts.md:167 by separating placeholder replacement,
source-control guidance, and secret references.
In `@en/docs/ai-workspace/1.0.0/setting-up/ports.md`:
- Line 126: Update the OIDC setup guidance to match the released 1.0.0
configuration: remove the claim that environment variables can override
redirect_url and post_logout_redirect_url unless the corresponding
[ai_workspace.auth.oidc] TOML values use explicit interpolation tokens. Verify
the 1.0.0 package configuration and document only supported override mechanisms.
In `@en/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.md`:
- Around line 161-162: Update the curl upload instructions for the upstream,
provider, LLM proxy, and MCP proxy manifests so placeholders such as
<upstream-url>, <upstream-api-key>, and <provider-api-key> are resolved before
each request is sent. Show a supported substitution or templating command rather
than uploading the YAML files unchanged with literal placeholder values.
---
Duplicate comments:
In
`@en/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.md`:
- Line 101: Update the issuer example in the authentication configuration to use
a base-issuer placeholder representing the issuer returned by OIDC discovery,
rather than the endpoint-shaped /oauth2token URL. Keep the example aligned with
the authority value used in the surrounding configuration and the Platform API
template.
In `@en/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.md`:
- Line 168: Update the authentication setup step describing optional
access-token claims: remove `preferred_username` and `email` from the required
configuration instructions, retain the existing `profile` and `email` scope
guidance, and state that the `email` claim may be absent. Reserve this step for
claims that actually require optional-claim configuration.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 7af37121-302c-4696-b5df-93aa795035c5
📒 Files selected for processing (31)
en/docs/ai-gateway/next/quick-start-guide.mden/docs/ai-workspace/1.0.0/ai-gateways/setting-up.mden/docs/ai-workspace/1.0.0/ci-cd/configure-ci-cd-workflow.mden/docs/ai-workspace/1.0.0/configure-inbound-auth.mden/docs/ai-workspace/1.0.0/getting-started.mden/docs/ai-workspace/1.0.0/insights.mden/docs/ai-workspace/1.0.0/llm-provider-templates/configure-template.mden/docs/ai-workspace/1.0.0/llm-provider-templates/manage-template.mden/docs/ai-workspace/1.0.0/llm-provider-templates/overview.mden/docs/ai-workspace/1.0.0/llm-providers/configure-provider.mden/docs/ai-workspace/1.0.0/llm-proxies/configure-proxy.mden/docs/ai-workspace/1.0.0/llm-proxies/manage-proxy.mden/docs/ai-workspace/1.0.0/mcp-proxies/apply-policies.mden/docs/ai-workspace/1.0.0/mcp-proxies/configure-proxy.mden/docs/ai-workspace/1.0.0/mcp-proxies/overview.mden/docs/ai-workspace/1.0.0/overview.mden/docs/ai-workspace/1.0.0/policies/apply-ai-policies-to-proxies.mden/docs/ai-workspace/1.0.0/policies/build-gateway-with-ai-policies.mden/docs/ai-workspace/1.0.0/policies/overview.mden/docs/ai-workspace/1.0.0/policies/writing-an-ai-policy.mden/docs/ai-workspace/1.0.0/secrets-management.mden/docs/ai-workspace/1.0.0/setting-up/authentication/asgardeo-setup.mden/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.mden/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.mden/docs/ai-workspace/1.0.0/setting-up/configuration.mden/docs/ai-workspace/1.0.0/setting-up/database.mden/docs/ai-workspace/1.0.0/setting-up/ports.mden/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.mden/docs/ai-workspace/1.0.0/using-sdks.mden/docs/ai-workspace/next/getting-started.mden/mkdocs.yml
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.md`:
- Around line 166-179: Make the manifest substitution commands safe for
arbitrary upstream URLs and API keys in the documented request examples,
including the corresponding blocks later in the guide. Either replace sed with
YAML-aware templating or escape replacement values for sed, and quote the
substituted YAML string fields so special characters are preserved as literal
values.
In `@en/docs/ai-workspace/next/setting-up/ports.md`:
- Line 115: Rewrite the reachability guidance in the ports documentation as a
short, direct instruction that names the configuration key. State that the key
must use an address reachable from the gateway, including the existing
host.docker.internal, hostname/IP, and platform-api examples as needed.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 6d18b377-1743-4b30-81e6-63916e84a69a
📒 Files selected for processing (11)
en/docs/ai-workspace/1.0.0/policies/apply-ai-policies-to-proxies.mden/docs/ai-workspace/1.0.0/policies/overview.mden/docs/ai-workspace/1.0.0/secrets-management.mden/docs/ai-workspace/1.0.0/setting-up/authentication/asgardeo-setup.mden/docs/ai-workspace/1.0.0/setting-up/authentication/connect-an-identity-provider.mden/docs/ai-workspace/1.0.0/setting-up/authentication/entra-id-setup.mden/docs/ai-workspace/1.0.0/setting-up/database.mden/docs/ai-workspace/1.0.0/setting-up/ports.mden/docs/ai-workspace/1.0.0/sync-gateway-created-artifacts.mden/docs/ai-workspace/next/setting-up/database.mden/docs/ai-workspace/next/setting-up/ports.md
…fest editing and clarify the configuration of `controlplane_host` for gateway connectivity.
Contributor
Author
|
@CodeRabbit approve |
✅ Action performedComments resolved and changes approved. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
$subject