Refactor AI Workspace documentation structure and content with claude rules - #391
Merged
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis documentation update consolidates AI Workspace policy guidance, expands setup and authentication procedures, documents database and port configuration, updates provider and proxy instructions, and reorganizes navigation and redirects. ChangesAI Workspace documentation
Estimated code review effort: 4 (Complex) | ~45 minutes Possibly related PRs
Suggested reviewers: 🚥 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 21
🤖 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/cloud/ai-workspace/llm-providers/manage-provider.md`:
- Line 64: Align AWS Bedrock’s availability between the provider overview and
manage-provider documentation: either remove AWS Bedrock from the editable
custom URL row in the provider configuration table, or update the corresponding
overview and setup instructions to consistently document it as available.
Preserve consistent availability status across all referenced cloud LLM provider
docs.
In `@en/docs/next/ai-workspace/authentication/connect-an-identity-provider.md`:
- Line 22: Shorten the explanatory sentences throughout the authentication
guide, including the referenced sections, so each sentence has fewer than 26
words. Split combined instructions into separate sentences or ordered-list steps
while preserving the explicit procedure and technical meaning.
- Around line 180-184: Update the restart command in the authentication
procedure to target only the two required authentication services by passing
their defined Compose service names explicitly. Preserve the detached and
force-recreate behavior, and do not recreate unrelated services.
- Around line 112-126: Update the AI Workspace claim-mapping example to match
the Platform API example key for key, including user_id, username, email, scope,
and roles alongside the organization claims. Ensure the documented mappings
remain consistent with the requirement in Step 5.
In `@en/docs/next/ai-workspace/authentication/overview.md`:
- Line 69: Rewrite the roles explanation near the token scope description using
clear, short declarative sentences: state that a user’s roles define their
complete grant, each role maps to scopes through the configured role-to-scope
mapping, and assigning multiple roles combines their grants. Preserve the
existing behavior and configuration details about startup failure for missing or
undefined roles.
- Line 83: Update the credential description near the Getting Started reference
to state that setup.sh provisions the gateway-controller admin credentials and
prints only the admin password once. Remove the claim that both username and
password are generated and printed, unless the script’s behavior is
intentionally changed to match it.
In `@en/docs/next/ai-workspace/configuration.md`:
- Line 17: Standardize the specified sentence-break hyphens to em dashes and
change “afterwards” to “afterward” across
en/docs/next/ai-workspace/configuration.md lines 17, 26, and 93-98;
en/docs/next/ai-workspace/ai-gateways/setting-up.md line 84;
en/docs/next/ai-workspace/getting-started.md lines 41, 59, 120, and 148; and
en/docs/next/ai-workspace/secrets-management.md lines 22-24. Preserve the
existing prose and use American-English punctuation consistently at each listed
site.
In `@en/docs/next/ai-workspace/database.md`:
- Line 42: Revise the affected documentation sentences around the container
path, SQLite description, and referenced lines to use shorter sentences or
lists. Replace every spaced em dash with a compliant unspaced em dash,
preserving the existing meaning and procedural details.
- Around line 77-83: Update the privilege instructions in the database guide to
clearly scope the existing GRANT block to PostgreSQL, and add equivalent SQL
Server permission steps if the guide’s SQL Server support requires them. Ensure
users are not directed to execute PostgreSQL-only schema and sequence commands
against SQL Server.
In `@en/docs/next/ai-workspace/getting-started.md`:
- Around line 126-130: Protect both documented secret files: in
en/docs/next/ai-workspace/getting-started.md lines 126-130, update the
encryption-key generation instructions to create the file with restrictive
permissions using umask 077 or mode 600 before mounting; in
en/docs/next/ai-workspace/overview.md lines 125-132, instruct users to exclude
./secrets/oidc_client_secret from source control and restrict its permissions.
- Around line 134-142: Update the TOML example’s raw-tag block by adding blank
lines between `{% raw %}` and the opening fence, and between the closing fence
and `{% endraw %}`. Keep the fenced content and raw tags unchanged so
markdownlint rule MD031 passes.
- Around line 113-120: The encryption-key rotation warning in the
getting-started documentation must describe all affected encrypted data, not
only AI Workspace secrets. Update the warning under `--rotate-encryption-key` to
also name API Portal subscription secrets and webhook secrets, while preserving
the existing confirmation and JWT-keypair guidance.
In `@en/docs/next/ai-workspace/insights.md`:
- Line 74: Rename the “Related” heading to “Related resources” in the document,
preserving the content that follows it.
In `@en/docs/next/ai-workspace/llm-providers/configure-provider.md`:
- Around line 91-92: Update the “Upstream URL” and “API Key” labels in the
provider configuration list to use valid Markdown emphasis syntax without
adjacent markers, following the linter-compatible form of bolding only the label
and placing “(required)” outside it.
In `@en/docs/next/ai-workspace/llm-providers/overview.md`:
- Around line 33-36: Update the decorative image alt text in the provider table
entries for Azure AI Foundry, Gemini, Mistral AI, and AWS Bedrock to empty alt
text, preserving the existing bold provider names and image styling.
- Around line 33-36: Update the Documentation link labels in the Azure AI
Foundry and AWS Bedrock rows to use provider-specific text: “Azure AI Foundry
documentation” and “AWS Bedrock documentation.” Leave the Gemini and Mistral AI
rows unchanged.
In `@en/docs/next/ai-workspace/policies/apply-ai-policies-to-proxies.md`:
- Line 101: Rename the “What’s Next?” heading to “Next steps” to provide a
descriptive sentence-case heading, preserving the surrounding documentation
content.
In `@en/docs/next/ai-workspace/policies/overview.md`:
- Around line 271-275: Add a warning to the Log message policy entry explaining
that authorization headers, API keys, prompts, and personally identifiable
information may be written to logs, and instruct users to restrict access to or
redact the logged output.
- Around line 145-151: Update the **Behavior** section of the rate-limiting
overview to explicitly warn that Redis failures disable quota enforcement and
may allow unrestricted traffic and increased costs. Add the documented
monitoring guidance or fail-closed configuration option if an existing symbol or
setting provides one; do not invent unsupported configuration details.
- Around line 18-20: Define acronyms at first use across all specified sites: in
en/docs/next/ai-workspace/policies/overview.md lines 18-20 define LLM and MCP;
in en/docs/next/ai-workspace/configuration.md lines 17 and 65-69 define BFF,
TOML, and OIDC; in en/docs/next/ai-workspace/getting-started.md lines 43-50
define TLS, RS256, JWT, HMAC, and AES-256; in en/docs/next/ai-workspace/ports.md
lines 17-23 and 123-124 define HTTPS and OIDC; in
en/docs/next/ai-workspace/secrets-management.md lines 22-24 and 353-355 define
OIDC and HMAC; and in en/docs/next/ai-workspace/overview.md line 112 define
OIDC. Expand each term in prose at its first occurrence while preserving the
existing meaning and formatting.
In `@en/docs/next/ai-workspace/ports.md`:
- Around line 46-53: Update the gateway setup procedure around
[ai_workspace.gateway] controlplane_host to use a gateway-reachable placeholder
rather than prescribing host.docker.internal universally. Retain
host.docker.internal:8244 only as a conditional example for
Docker-host-resolving gateways, while leaving [ai_workspace.control_plane] url
unchanged.
🪄 Autofix (Beta)
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: 0864c5bb-fab5-4aba-aadc-5f873d050162
⛔ Files ignored due to path filters (2)
en/docs/assets/img/ai-gateway/standalone-ai-workspace/llm-provider/llm-provider-details.pngis excluded by!**/*.pngen/docs/assets/img/ai-gateway/standalone-ai-workspace/llm-provider/select-llm-provider-type.pngis excluded by!**/*.png
📒 Files selected for processing (40)
en/docs/ai-gateway/next/llm-proxy/multi-provider-routing.mden/docs/cloud/ai-workspace/llm-providers/manage-provider.mden/docs/cloud/ai-workspace/llm-providers/overview.mden/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/authentication/connect-an-identity-provider.mden/docs/next/ai-workspace/authentication/overview.mden/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.mden/docs/next/ai-workspace/configuration.mden/docs/next/ai-workspace/configure-inbound-auth.mden/docs/next/ai-workspace/database.mden/docs/next/ai-workspace/genai-applications.mden/docs/next/ai-workspace/getting-started.mden/docs/next/ai-workspace/insights.mden/docs/next/ai-workspace/llm-provider-templates/configure-template.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-providers/manage-provider.mden/docs/next/ai-workspace/llm-providers/overview.mden/docs/next/ai-workspace/llm-proxies/configure-proxy.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/overview.mden/docs/next/ai-workspace/policies/apply-ai-policies-to-proxies.mden/docs/next/ai-workspace/policies/guardrails/azure-content-safety.mden/docs/next/ai-workspace/policies/guardrails/overview.mden/docs/next/ai-workspace/policies/guardrails/regex-pii-masking.mden/docs/next/ai-workspace/policies/guardrails/semantic-prompt-guard.mden/docs/next/ai-workspace/policies/guardrails/sentence-count-guardrail.mden/docs/next/ai-workspace/policies/guardrails/word-count-guardrail.mden/docs/next/ai-workspace/policies/other-policies/basic-rate-limit.mden/docs/next/ai-workspace/policies/other-policies/model-round-robin.mden/docs/next/ai-workspace/policies/other-policies/prompt-decorator.mden/docs/next/ai-workspace/policies/other-policies/prompt-template.mden/docs/next/ai-workspace/policies/other-policies/semantic-cache.mden/docs/next/ai-workspace/policies/other-policies/token-based-rate-limit.mden/docs/next/ai-workspace/policies/overview.mden/docs/next/ai-workspace/policies/rate-limit/llm-cost-based-rate-limit.mden/docs/next/ai-workspace/policies/rate-limit/llm-cost.mden/docs/next/ai-workspace/policies/rate-limit/token-based-rate-limit.mden/docs/next/ai-workspace/ports.mden/docs/next/ai-workspace/secrets-management.mden/mkdocs.yml
💤 Files with no reviewable changes (15)
- en/docs/next/ai-workspace/policies/other-policies/model-round-robin.md
- en/docs/next/ai-workspace/policies/other-policies/prompt-template.md
- en/docs/next/ai-workspace/policies/guardrails/regex-pii-masking.md
- en/docs/next/ai-workspace/policies/guardrails/sentence-count-guardrail.md
- en/docs/next/ai-workspace/policies/guardrails/semantic-prompt-guard.md
- en/docs/next/ai-workspace/policies/other-policies/token-based-rate-limit.md
- en/docs/next/ai-workspace/policies/other-policies/semantic-cache.md
- en/docs/next/ai-workspace/policies/rate-limit/token-based-rate-limit.md
- en/docs/next/ai-workspace/policies/guardrails/overview.md
- en/docs/next/ai-workspace/policies/rate-limit/llm-cost-based-rate-limit.md
- en/docs/next/ai-workspace/policies/rate-limit/llm-cost.md
- en/docs/next/ai-workspace/policies/guardrails/azure-content-safety.md
- en/docs/next/ai-workspace/policies/other-policies/prompt-decorator.md
- en/docs/next/ai-workspace/policies/guardrails/word-count-guardrail.md
- en/docs/next/ai-workspace/policies/other-policies/basic-rate-limit.md
Thushani-Jayasekera
changed the title
Contributor
Author
|
@CodeRabbit review |
✅ Action performedReview finished.
|
Contributor
Author
|
@CodeRabbit review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 40
🤖 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/next/ai-workspace/ai-gateways/setting-up.md`:
- Line 35: Standardize the gateway status terminology across the page, including
the table and the creation and connection steps at the referenced locations.
Confirm the UI’s exact label, then use that same status value everywhere and
remove “current” from the table description if it adds no meaning.
- Line 53: In the setup documentation section immediately before the AI Gateway
form image, add a complete standalone sentence introducing what the screenshot
shows and end it with a colon; leave the existing image and its alt text
unchanged.
In `@en/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.md`:
- Around line 336-341: Update the YAML fenced block under the project-not-found
list item by indenting it as part of the list item and adding blank lines
immediately before and after the fence, resolving the Markdown MD031 violation
without changing its content.
- Around line 283-291: Update the three image alt texts near the LLM provider
and proxy screenshots to use sentence case and replace the undefined “DP origin”
abbreviation with “gateway-origin,” using clear descriptions for access control,
token mapping, and deployment.
In `@en/docs/next/ai-workspace/configuration.md`:
- Line 67: Update the credential list in the section around “AI Workspace
secrets” to insert “and” before the final at-rest encryption key item,
preserving the Oxford comma style.
- Line 17: Shorten the documentation sentences to fewer than 26 words and
separate compound ideas. Update configuration.md lines 17-17 by splitting the
stack description and provisioning explanation; configuration.md lines 57-57 by
separating service-prefix mappings; setting-up.md lines 82-82 by separating
display-only behavior from gateway reachability; getting-started.md lines 41-41
by separating startup failures from credential prompts; getting-started.md lines
120-120 by separating encryption-key scope from confirmation behavior; and
getting-started.md lines 151-151 by separating environment-file loading from
restart instructions.
- Line 86: Update the configuration documentation around the shipped-token
defaults and fail-closed behavior to clarify that only tokens with an explicit
default fall back when unset or empty; tokens without a default, including
client_secret, are required secrets and must cause startup to fail when missing.
In `@en/docs/next/ai-workspace/configure-inbound-auth.md`:
- Around line 37-39: Update the fenced header example in
configure-inbound-auth.md to include an appropriate language identifier, such as
http or text, so it satisfies Markdownlint rule MD040.
- Line 17: Rewrite the introductory explanation in the Security-tab paragraph to
define inbound authentication as the gateway’s check of client requests, not as
the key itself. Clearly identify the client-supplied key as the credential used
for that check and distinguish it from the upstream API key used by the gateway
with the LLM provider; use short, direct sentences.
In `@en/docs/next/ai-workspace/database.md`:
- Line 60: Expand the SQL Server setup branch in the database documentation with
executable CREATE DATABASE and CREATE LOGIN commands, then add the command or an
existing link for running the SQL Server schema script. Keep the existing
instruction that Step 2 maps the login to a database user.
In `@en/docs/next/ai-workspace/genai-applications.md`:
- Line 126: Add exactly one trailing newline after the final list item in
genai-applications.md so the file ends with a single newline and satisfies
markdownlint MD047.
- Line 19: Update the usage description near the GenAI applications section by
splitting the overlong sentence into sentences of fewer than 26 words and
explicitly identifying models, tokens, and cost as separate tracked metrics.
- Line 27: Change the specified Markdown headings to sentence case: in
en/docs/next/ai-workspace/genai-applications.md at lines 27, 38, 70, 82, 98, and
114, use “When to use GenAI applications,” “How it works,” “Attach API keys to
an application,” “View and manage attached keys,” “Insights for GenAI
applications,” and “Best practices”; in en/docs/next/ai-workspace/overview.md at
lines 41 and 51, use “App LLM proxies” and “GenAI applications.” Preserve
product names and acronyms.
In `@en/docs/next/ai-workspace/getting-started.md`:
- Line 53: Update the setup command in the getting-started documentation to
replace the ambiguous `ADMIN_PASSWORD='…'` placeholder with an explicit value
that clearly instructs readers to substitute their own password or generate one
inline, while preserving the existing environment-variable usage.
In `@en/docs/next/ai-workspace/insights.md`:
- Line 56: Use descriptive sentence-case headings in all three affected files:
rename the heading at en/docs/next/ai-workspace/insights.md:56 to “Using
Insights for cost and rate limit management”; rename “What’s Next?” at
en/docs/next/ai-workspace/policies/writing-an-ai-policy.md:254 to “Next steps”;
and rename the heading at
en/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.md:15 to
“Syncing gateway-created AI artifacts to the AI Workspace”.
In `@en/docs/next/ai-workspace/llm-provider-templates/manage-template.md`:
- Line 19: Update the Markdown heading “Use a Template to Create a Provider” to
sentence case: “Use a template to create a provider.”
- Line 43: Update the template-version documentation sentence to use the
American English term “afterward” and keep the wording within the 26-word limit,
splitting it into two concise sentences if needed. Preserve the existing
explanation that changes only affect providers created after the template
update.
In `@en/docs/next/ai-workspace/llm-provider-templates/overview.md`:
- Line 38: Update the template-card description in the overview documentation to
remove the temporal phrase “most recent version” and use a stable description
such as “the version shown on each template card,” while preserving the
surrounding statements about template sections and disabled styling.
In `@en/docs/next/ai-workspace/llm-providers/configure-provider.md`:
- Line 26: Add terminal punctuation to the API credentials prerequisite list
item in the provider configuration documentation, ending the sentence with a
period while leaving its wording unchanged.
- Line 92: Update the API Key description near the “API Key” text to remove the
trailing space from the inline `Bearer` code span, and reword the sentence to
state that AI Workspace adds the `Bearer` prefix followed by a space.
- Line 169: Add exactly one trailing newline after the final list item in
en/docs/next/ai-workspace/llm-providers/configure-provider.md at lines 169-169
and en/docs/next/ai-workspace/mcp-proxies/overview.md at lines 40-40; make no
other content changes.
- Line 101: Update the custom LLM provider template link in the documentation
sentence to use an anchor matching an existing heading in overview.md, or add
the missing connecting-a-custom-provider heading there if that is the intended
section. Keep the surrounding authentication guidance unchanged.
- Line 24: Rewrite the authorization prerequisite in configure-provider.md as
short, declarative bullets: list the required scopes and their purpose, then
separately state the relevant role-to-scope mappings and the ap_publisher
API-key limitation. Verify every scope and role claim against the role-to-scope
mapping in authentication/overview.md, correcting any discrepancies.
In `@en/docs/next/ai-workspace/llm-providers/manage-provider.md`:
- Line 131: Update the sentence in the provider management documentation to
remove the comma before “to prevent,” preserving the rest of the wording
unchanged.
- Line 140: Insert a complete standalone introductory sentence immediately
before the rate-limiting screenshot in the provider documentation, describing
that the Backend section displays the Provider-wide and Per Resource modes.
Leave the existing image and its alt text unchanged.
- Line 19: Update the Markdown headings to sentence case in
en/docs/next/ai-workspace/llm-providers/manage-provider.md at lines 19, 36, 69,
109, and 129; en/docs/next/ai-workspace/llm-providers/overview.md at lines 24
and 38; en/docs/next/ai-workspace/llm-proxies/configure-proxy.md at line 29;
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md at line 21; and
en/docs/next/ai-workspace/llm-proxies/overview.md at line 23. Lowercase
non-initial words exactly as specified while preserving proper names such as App
and OpenAPI.
In `@en/docs/next/ai-workspace/llm-providers/overview.md`:
- Line 40: Update the documentation punctuation at
en/docs/next/ai-workspace/llm-providers/overview.md:40-40 and
en/docs/next/ai-workspace/using-sdks.md:19-19 by replacing spaced em-dash
constructions with separate sentences; update
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md:211-212 to use a colon or
an unspaced em dash; and update
en/docs/next/ai-workspace/llm-proxies/overview.md:38-38 to remove spaces around
the em dash while correcting the sentence.
In `@en/docs/next/ai-workspace/llm-proxies/configure-proxy.md`:
- Line 17: Shorten the documentation sentences to fewer than 26 words and use
explicit lists for complex guidance. In
en/docs/next/ai-workspace/llm-proxies/configure-proxy.md lines 17-17, split the
introductory sentence; in lines 24-24, convert scopes, secret requirements, and
role mappings into nested bullets. In
en/docs/next/ai-workspace/llm-providers/overview.md lines 40-40, separate
custom-template behavior into short sentences or bullets. In
en/docs/next/ai-workspace/llm-proxies/overview.md lines 21-21 and 38-38, split
the specialization and capability sentences, using “dev, staging, and
production” at lines 38-38. In en/docs/next/ai-workspace/using-sdks.md lines
17-17, separate deployment, URL, SDK, and authentication instructions.
In `@en/docs/next/ai-workspace/llm-proxies/manage-proxy.md`:
- Around line 153-155: Update the “Resource-wise Guardrails” heading and its
description to use “resource-level” consistently, matching the terminology in
the provider documentation.
In `@en/docs/next/ai-workspace/llm-proxies/overview.md`:
- Line 38: Update the proxy description in the overview documentation to remove
the claim that each proxy has independent rate limits. State that guardrails,
access keys, and exposed resources are independent per proxy, while
provider-level rate limits remain shared across proxies using the same provider
backend.
- Line 41: Qualify the provider-switching statement in the overview by limiting
the no-client-changes guarantee to switches between compatible providers that
preserve the client-facing contract, including authentication and available
resources. Keep the proxy URL example while avoiding an unconditional guarantee.
In `@en/docs/next/ai-workspace/mcp-proxies/apply-policies.md`:
- Line 20: Update the sentence describing MCP-specific policy rules so the
relative clause agrees with plural “rules” and clearly states that the policy
applies at each capability level. Prefer splitting the sentence into short,
clear sentences.
- Line 18: Update the policy-attachment instruction near the MCP proxy setup to
match the navigation described in policies/overview.md, directing users to the
appropriate provider or App LLM proxy management tab instead of the Policies
page. Verify the actual UI location and use the same terminology consistently.
In `@en/docs/next/ai-workspace/mcp-proxies/configure-proxy.md`:
- Around line 36-37: Update the warning title in the MCP proxy configuration
documentation from “Protected Servers” to “Protected servers,” preserving the
existing warning content.
- Around line 43-51: Update the labels in the numbered proxy configuration list
to use sentence case: change every “(Required)” to “(required)” and every
“(Optional)” to “(optional)” while leaving the surrounding instructions
unchanged.
In `@en/docs/next/ai-workspace/overview.md`:
- Around line 43-45: Update the documentation terminology in the overview
content around the specialized proxy endpoint guidance and the related line 53
reference: replace “GenAI apps” and “AI applications” with “GenAI applications,”
while retaining “agents” only where it refers to a separate resource.
- Line 112: Update the interpolation bullet in the documentation to split the
token behavior, sensitive-value guidance, and allowed-path restriction into
separate sentences. Keep all existing details and configuration names unchanged,
with each sentence under 26 words.
In `@en/docs/next/ai-workspace/policies/apply-ai-policies-to-proxies.md`:
- Line 17: Apply the documentation-style updates across all listed sites: split
long or compound sentences into short sentences; define each acronym at first
use, including LLM, MCP, CLI, CI/CD, GenAI, HTTP, OIDC, PKCE, and SSE; and
remove spaces surrounding em dashes, including paired em dashes. Update every
specified file and line range: apply-ai-ai-policies-to-proxies.md (17-17, 47-48,
87-87); build-gateway-with-ai-policies.md (21-21, 155-155); insights.md (52-52);
policies/overview.md (154-154); writing-an-ai-policy.md (54-54, 252-252);
bottom-up-ai-artifact-deployment-guide.md (19-19, 25-26, 68-68, 71-71, 101-101,
111-111, 271-271, 279-279, 326-326); authentication/asgardeo-setup.md (33-33,
155-155); authentication/connect-an-identity-provider.md (166-168, 180-180); and
authentication/overview.md (109-109), preserving the original meaning and
technical terminology.
In `@en/docs/next/ai-workspace/policies/build-gateway-with-ai-policies.md`:
- Line 193: Update the next-step link description for “Apply AI policies to
proxies” so it explicitly lists LLM providers, App LLM proxies, and MCP proxies
while preserving the existing link and guidance.
In `@en/docs/next/ai-workspace/policies/overview.md`:
- Around line 107-108: Update the rate-limit entries in the policy table and
their corresponding headings so fragment targets match exactly, using the
heading text “Rate limit - basic” and “Rate limit - advanced” or matching
fragment links. If the labels retain an em dash, remove spaces around it to
satisfy the requested separator formatting.
🪄 Autofix (Beta)
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: f8239c0d-c910-454d-8ed4-32bcd03dacb7
📒 Files selected for processing (34)
en/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/authentication/asgardeo-setup.mden/docs/next/ai-workspace/authentication/connect-an-identity-provider.mden/docs/next/ai-workspace/authentication/overview.mden/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.mden/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.mden/docs/next/ai-workspace/ci-cd/overview.mden/docs/next/ai-workspace/configuration.mden/docs/next/ai-workspace/configure-inbound-auth.mden/docs/next/ai-workspace/database.mden/docs/next/ai-workspace/genai-applications.mden/docs/next/ai-workspace/getting-started.mden/docs/next/ai-workspace/insights.mden/docs/next/ai-workspace/llm-provider-templates/configure-template.mden/docs/next/ai-workspace/llm-provider-templates/manage-template.mden/docs/next/ai-workspace/llm-provider-templates/overview.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-providers/manage-provider.mden/docs/next/ai-workspace/llm-providers/overview.mden/docs/next/ai-workspace/llm-proxies/configure-proxy.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/llm-proxies/overview.mden/docs/next/ai-workspace/mcp-proxies/apply-policies.mden/docs/next/ai-workspace/mcp-proxies/configure-proxy.mden/docs/next/ai-workspace/mcp-proxies/overview.mden/docs/next/ai-workspace/overview.mden/docs/next/ai-workspace/policies/apply-ai-policies-to-proxies.mden/docs/next/ai-workspace/policies/build-gateway-with-ai-policies.mden/docs/next/ai-workspace/policies/overview.mden/docs/next/ai-workspace/policies/writing-an-ai-policy.mden/docs/next/ai-workspace/ports.mden/docs/next/ai-workspace/secrets-management.mden/docs/next/ai-workspace/using-sdks.mden/mkdocs.yml
There was a problem hiding this comment.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/docs/next/ai-workspace/mcp-proxies/apply-policies.md (1)
38-38: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winName the standard policies that are incompatible with MCP.
Some of themhas no clear referent, andbehavior varies by policydoes not tell readers which policies are safe or what happens. List the incompatible policies and their behavior, or link to a compatibility reference.As per coding guidelines, avoid ambiguous references and vague phrasing. The path instructions require these rules for
en/docs/**/*.md.🤖 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/next/ai-workspace/mcp-proxies/apply-policies.md` at line 38, Update the MCP proxy policy guidance in the surrounding documentation to explicitly identify every standard policy incompatible with MCP and describe each policy’s behavior, or link to an authoritative compatibility reference. Replace the vague phrases “Some of them” and “behavior varies by policy” with precise compatibility information.Sources: Coding guidelines, Path instructions
🤖 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/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.md`:
- Line 122: Update the Step 1 heading and the corresponding headings at Steps
2–4 in this AI artifact deployment guide to use the colon separator consistently
with writing-an-ai-policy.md, replacing “Step N -” with “Step N:”.
In `@en/docs/next/ai-workspace/llm-providers/manage-provider.md`:
- Line 164: Update the instruction near “Request Count” and “Token Count” to
explicitly say users can enable Request Count, Token Count, or both, replacing
the ambiguous “and/or” wording while preserving the existing formatting.
- Line 148: Update the provider-wide limit description so the complete HTTP
status code is enclosed in one inline code span, changing the current partial
formatting of 429 while preserving the surrounding text.
- Around line 185-197: Update the guardrail scope wording in the introductory
paragraph to say “globally to all endpoints or at the resource level to specific
endpoints.” In the Add a guardrail section, preserve consistent “resource-level”
terminology and use direct, grammatically clear sentences.
In `@en/docs/next/ai-workspace/llm-providers/overview.md`:
- Line 40: Update the custom LLM Provider Template description near the provider
list to replace “an organization admin” with permission-neutral wording such as
“a user with template-management access,” preserving the existing template
behavior and keeping terminology consistent with configure-template.md.
In `@en/docs/next/ai-workspace/mcp-proxies/apply-policies.md`:
- Line 44: Update the Policy Hub description near the catalog link to refer to
its entries as “policies” instead of “guardrails,” matching the terminology used
elsewhere in the document and preserving the catalog’s broader scope.
In `@en/docs/next/ai-workspace/overview.md`:
- Line 76: Replace the spaced hyphen and extra whitespace in the Insights link
description with a single em dash directly before “The gateway,” preserving the
rest of the sentence unchanged.
---
Outside diff comments:
In `@en/docs/next/ai-workspace/mcp-proxies/apply-policies.md`:
- Line 38: Update the MCP proxy policy guidance in the surrounding documentation
to explicitly identify every standard policy incompatible with MCP and describe
each policy’s behavior, or link to an authoritative compatibility reference.
Replace the vague phrases “Some of them” and “behavior varies by policy” with
precise compatibility information.
🪄 Autofix (Beta)
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: 28add46f-c19d-4a48-95be-6c4fe8f8feb6
📒 Files selected for processing (27)
en/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.mden/docs/next/ai-workspace/configuration.mden/docs/next/ai-workspace/configure-inbound-auth.mden/docs/next/ai-workspace/database.mden/docs/next/ai-workspace/genai-applications.mden/docs/next/ai-workspace/getting-started.mden/docs/next/ai-workspace/insights.mden/docs/next/ai-workspace/llm-provider-templates/configure-template.mden/docs/next/ai-workspace/llm-provider-templates/manage-template.mden/docs/next/ai-workspace/llm-provider-templates/overview.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-providers/manage-provider.mden/docs/next/ai-workspace/llm-providers/overview.mden/docs/next/ai-workspace/llm-proxies/configure-proxy.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/llm-proxies/overview.mden/docs/next/ai-workspace/mcp-proxies/apply-policies.mden/docs/next/ai-workspace/mcp-proxies/configure-proxy.mden/docs/next/ai-workspace/mcp-proxies/overview.mden/docs/next/ai-workspace/overview.mden/docs/next/ai-workspace/policies/apply-ai-policies-to-proxies.mden/docs/next/ai-workspace/policies/build-gateway-with-ai-policies.mden/docs/next/ai-workspace/policies/overview.mden/docs/next/ai-workspace/policies/writing-an-ai-policy.mden/docs/next/ai-workspace/using-sdks.mden/mkdocs.yml
…pdating navigation links, and enhancing clarity. Introduce new guide for syncing gateway-created artifacts to AI Workspace.
There was a problem hiding this comment.
Actionable comments posted: 12
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
en/docs/next/ai-workspace/setting-up/authentication/overview.md (2)
50-50: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winApply the short-sentence and em-dash rules across both authentication pages.
en/docs/next/ai-workspace/setting-up/authentication/overview.md#L50-L50: Split the long user-list explanation and remove spaced em dashes.en/docs/next/ai-workspace/setting-up/authentication/overview.md#L88-L88: Split the longsetup.shexplanation.en/docs/next/ai-workspace/setting-up/authentication/overview.md#L109-L109: Split the long identity-provider link explanation.en/docs/next/ai-workspace/setting-up/authentication/overview.md#L113-L113: Split the long mode-selection sentence.en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md#L33-L33: Split the long BFF explanation.As per coding guidelines, use short sentences and unspaced em dashes. As per path instructions, report every documentation style violation in
en/docs/**/*.md.🤖 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/next/ai-workspace/setting-up/authentication/overview.md` at line 50, Apply the documentation style fixes across en/docs/next/ai-workspace/setting-up/authentication/overview.md#L50-L50, `#L88-L88`, `#L109-L109`, and `#L113-L113`, plus en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md#L33-L33: split each long explanation or sentence into concise sentences, and replace spaced em dashes with unspaced em dashes while preserving the existing meaning.Sources: Coding guidelines, Path instructions
42-45: 🔒 Security & Privacy | 🟡 Minor | ⚡ Quick winDo not pass the password with
htpasswd -b.The command passes the password as a shell argument, which can be captured in shell history and process listings. Use an interactive prompt or another secret-safe tool.
Proposed wording
-htpasswd -bnBC 12 "" "your-password" | tr -d ':\n' +htpasswd -nBC 12 "" | tr -d ':\n'🤖 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/next/ai-workspace/setting-up/authentication/overview.md` around lines 42 - 45, Update the password-hash instructions near the bcrypt example to remove the unsafe htpasswd -b command and replace it with an interactive prompt or another secret-safe standard tool, ensuring the password is not exposed in shell history or process listings.en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md (1)
151-153: 🔒 Security & Privacy | 🟡 Minor | ⚡ Quick winDo not expose the client secret in shell commands.
The
exportexample can store the secret in shell history when users replace the placeholder. Use an interactive prompt instead, and keepapi-platform.envout of the final shell path.Proposed wording
-export APIP_AIW_AUTH_OIDC_CLIENT_SECRET=<ai-workspace-client-secret> +read -r -s -p 'OIDC client secret: ' APIP_AIW_AUTH_OIDC_CLIENT_SECRET +printf '\n' +export APIP_AIW_AUTH_OIDC_CLIENT_SECRET🤖 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/next/ai-workspace/setting-up/authentication/asgardeo-setup.md` around lines 151 - 153, Replace the plain export example in the authentication setup instructions with an interactive prompt that avoids recording the client secret in shell history, and ensure api-platform.env is not included in the final shell path or command sequence.en/docs/next/ai-workspace/ci-cd/overview.md (1)
21-23: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winUse unspaced em dashes throughout the changed documentation.
The changed lists and explanations use spaces around em dashes.
en/docs/next/ai-workspace/ci-cd/overview.md#L21-L23: Remove spaces around the artifact-list em dashes.en/docs/next/ai-workspace/ci-cd/overview.md#L95-L98: Remove spaces around the benefits-list em dashes.en/docs/next/ai-workspace/genai-applications.md#L19-L19: Remove spaces around both metrics em dashes.en/docs/next/ai-workspace/overview.md#L41-L41: Remove spaces around the policy-definition em dash.en/docs/next/ai-workspace/overview.md#L97-L99: Remove spaces around the governance-list em dashes.en/docs/next/ai-workspace/overview.md#L138-L138: Remove spaces around the runtime-description em dash.As per coding guidelines, use em dashes without surrounding spaces. As per path instructions, report this violation in
en/docs/**/*.md.🤖 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/next/ai-workspace/ci-cd/overview.md` around lines 21 - 23, Remove surrounding spaces from every em dash in the specified documentation: en/docs/next/ai-workspace/ci-cd/overview.md lines 21-23 and 95-98, en/docs/next/ai-workspace/genai-applications.md line 19, and en/docs/next/ai-workspace/overview.md lines 41, 97-99, and 138. Preserve the surrounding text while applying the unspaced em-dash style consistently.Sources: Coding guidelines, Path instructions
🤖 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/next/ai-workspace/ai-gateways/setting-up.md`:
- Line 17: Expand acronyms at first use in all affected setup guides: in
en/docs/next/ai-workspace/ai-gateways/setting-up.md:17,
en/docs/next/ai-workspace/getting-started.md:17, and
en/docs/next/ai-workspace/sync-gateway-created-artifacts.md:17, use “large
language model (LLM)”; in en/docs/next/ai-workspace/secrets-management.md:20,
use “large language model (LLM)” and “Model Context Protocol (MCP)”; and in
en/docs/next/ai-workspace/secrets-management.md:48, use “JSON Web Token (JWT)”.
- Line 21: Rewrite the guidance at
en/docs/next/ai-workspace/ai-gateways/setting-up.md:21 into separate sentences
or bullets for scopes, role mappings, and permission exceptions. At
en/docs/next/ai-workspace/secrets-management.md:23, split the credential list
into shorter sentences. At
en/docs/next/ai-workspace/sync-gateway-created-artifacts.md:17, separate the
artifact list from synchronization behavior. At
en/docs/next/ai-workspace/sync-gateway-created-artifacts.md:99, separate the
dependency chain, API behavior, and synchronization behavior; keep every
resulting sentence under 26 words.
In `@en/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.md`:
- Line 90: Update the declarative CI/CD independence statement to clarify that
AI Workspace artifact and gateway runtime operations run independently from each
other while using the project files. Preserve the existing synchronous execution
and synchronization behavior details, matching the distinction used in the CI/CD
overview.
In `@en/docs/next/ai-workspace/ci-cd/overview.md`:
- Line 55: Update the runtime.yaml table entry to describe the deployment
command rather than implying the file performs deployment. State that `ap
gateway apply -f runtime.yaml` applies the runtime configuration and artifact to
the gateway, while retaining the file’s role in defining runtime behavior.
- Line 17: Ensure every sentence under 26 words in
en/docs/next/ai-workspace/ci-cd/overview.md:17 and
en/docs/next/ai-workspace/overview.md:19,138. Split or shorten the opening and
responsibility sentences; split the closing runtime-documentation sentence and
explicitly name “the AI Workspace documentation.”
In `@en/docs/next/ai-workspace/llm-provider-templates/configure-template.md`:
- Line 21: Update the prerequisite statement in the provider template
configuration documentation to explicitly require both ap:llm_template:manage
and ap:llm_template:read, or clearly state that the applicable roles provide
both through the role-to-scope mapping. Preserve the existing role references
and distinguish management permissions from the ability to list templates.
In `@en/docs/next/ai-workspace/llm-providers/configure-provider.md`:
- Line 103: Update the Bedrock endpoint guidance in configure-provider.md to
apply the region-specific key warning only to short-term API keys; clarify that
long-term service-specific IAM credentials are not subject to this restriction
while preserving the endpoint’s runtime region configuration guidance.
In `@en/docs/next/ai-workspace/llm-proxies/manage-proxy.md`:
- Line 15: Update the introduction and any other references in the document to
use the exact term “App LLM proxy” consistently, replacing “specialized
application or agent proxy” when it refers to the same product. Preserve the
existing heading and meaning.
In `@en/docs/next/ai-workspace/policies/overview.md`:
- Around line 286-287: Standardize the changed documentation to use unspaced em
dashes at every affected site: update
en/docs/next/ai-workspace/policies/overview.md lines 286-287,
en/docs/next/ai-workspace/insights.md lines 76-79,
en/docs/next/ai-workspace/getting-started.md lines 69 and 90,
en/docs/next/ai-workspace/sync-gateway-created-artifacts.md lines 17, 23-24, 99,
and 324, and en/docs/next/ai-workspace/secrets-management.md lines 18, 23, and
124. Remove surrounding spaces from each specified delimiter, including both
paired em dashes where indicated, without changing the surrounding prose.
In `@en/docs/next/ai-workspace/secrets-management.md`:
- Line 18: Update the sentence in the AI Workspace secrets documentation to
remove spaces around the em dash, preserving the existing wording and emphasis.
In `@en/docs/next/ai-workspace/setting-up/configuration.md`:
- Line 3: Update the description near the document front matter to use the
plural possessive “their” when referring to AI Workspace and the Platform API,
while preserving the rest of the sentence.
In `@en/docs/next/ai-workspace/sync-gateway-created-artifacts.md`:
- Around line 227-229: Update the text introducing each screenshot in the
documented sync steps, including the sections under “Settings” > “LLM Provider
Templates” and the additionally noted screenshot blocks, so each fragment
becomes a complete standalone sentence ending with a colon immediately before
its image.
---
Outside diff comments:
In `@en/docs/next/ai-workspace/ci-cd/overview.md`:
- Around line 21-23: Remove surrounding spaces from every em dash in the
specified documentation: en/docs/next/ai-workspace/ci-cd/overview.md lines 21-23
and 95-98, en/docs/next/ai-workspace/genai-applications.md line 19, and
en/docs/next/ai-workspace/overview.md lines 41, 97-99, and 138. Preserve the
surrounding text while applying the unspaced em-dash style consistently.
In `@en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md`:
- Around line 151-153: Replace the plain export example in the authentication
setup instructions with an interactive prompt that avoids recording the client
secret in shell history, and ensure api-platform.env is not included in the
final shell path or command sequence.
In `@en/docs/next/ai-workspace/setting-up/authentication/overview.md`:
- Line 50: Apply the documentation style fixes across
en/docs/next/ai-workspace/setting-up/authentication/overview.md#L50-L50,
`#L88-L88`, `#L109-L109`, and `#L113-L113`, plus
en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md#L33-L33:
split each long explanation or sentence into concise sentences, and replace
spaced em dashes with unspaced em dashes while preserving the existing meaning.
- Around line 42-45: Update the password-hash instructions near the bcrypt
example to remove the unsafe htpasswd -b command and replace it with an
interactive prompt or another secret-safe standard tool, ensuring the password
is not exposed in shell history or process listings.
🪄 Autofix (Beta)
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: 95b6e023-6a94-4671-bed0-18753b8bab6a
📒 Files selected for processing (34)
en/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.mden/docs/next/ai-workspace/ci-cd/overview.mden/docs/next/ai-workspace/configure-inbound-auth.mden/docs/next/ai-workspace/genai-applications.mden/docs/next/ai-workspace/getting-started.mden/docs/next/ai-workspace/insights.mden/docs/next/ai-workspace/llm-provider-templates/configure-template.mden/docs/next/ai-workspace/llm-provider-templates/manage-template.mden/docs/next/ai-workspace/llm-provider-templates/overview.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-providers/manage-provider.mden/docs/next/ai-workspace/llm-providers/overview.mden/docs/next/ai-workspace/llm-proxies/configure-proxy.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/llm-proxies/overview.mden/docs/next/ai-workspace/mcp-proxies/apply-policies.mden/docs/next/ai-workspace/mcp-proxies/configure-proxy.mden/docs/next/ai-workspace/mcp-proxies/overview.mden/docs/next/ai-workspace/overview.mden/docs/next/ai-workspace/policies/apply-ai-policies-to-proxies.mden/docs/next/ai-workspace/policies/build-gateway-with-ai-policies.mden/docs/next/ai-workspace/policies/overview.mden/docs/next/ai-workspace/policies/writing-an-ai-policy.mden/docs/next/ai-workspace/secrets-management.mden/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.mden/docs/next/ai-workspace/setting-up/authentication/connect-an-identity-provider.mden/docs/next/ai-workspace/setting-up/authentication/overview.mden/docs/next/ai-workspace/setting-up/configuration.mden/docs/next/ai-workspace/setting-up/database.mden/docs/next/ai-workspace/setting-up/ports.mden/docs/next/ai-workspace/sync-gateway-created-artifacts.mden/docs/next/ai-workspace/using-sdks.mden/mkdocs.yml
…y. Adjust phrasing for better readability, enhance descriptions of components, and ensure uniform formatting across sections.
Contributor
Author
|
@CodeRabbit review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/docs/next/ai-workspace/ai-gateways/setting-up.md (1)
101-103: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winAlign the archive and directory names with the downloaded release.
Line 101 downloads
wso2apip-ai-gateway-1.2.0-rc.zip, but theunzipandcdcommands use1.2.0. The setup fails because these names do not match. Apply the same correction in all three installation methods.Proposed correction
- unzip wso2apip-ai-gateway-1.2.0.zip + unzip wso2apip-ai-gateway-1.2.0-rc.zip - cd wso2apip-ai-gateway-1.2.0 && ./scripts/setup.sh + cd wso2apip-ai-gateway-1.2.0-rc && ./scripts/setup.shAlso applies to: 110-110, 164-166, 173-173, 215-217, 224-224
🤖 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/next/ai-workspace/ai-gateways/setting-up.md` around lines 101 - 103, Align the archive and directory references in all three installation methods with the downloaded v1.2.0-rc release: update every unzip and cd command to use the -rc suffix consistently with the curl filename. Apply this to the affected setup blocks without changing unrelated commands.
🤖 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/next/ai-workspace/llm-provider-templates/configure-template.md`:
- Line 21: Update the role and scope description in the LLM provider template
documentation to use direct role-to-scope wording: state that the mapping grants
both scopes to ap_admin and ap_operator, while ap_publisher and ap_viewer
receive only ap:llm_template:read, which permits listing templates but not
modifying them. Replace ambiguous wording such as “ships” and “lists templates”
without changing the permissions described.
In `@en/docs/next/ai-workspace/llm-providers/configure-provider.md`:
- Line 103: Update the Bedrock endpoint paragraph to expand IAM at its first
occurrence as “Identity and Access Management (IAM),” then retain the IAM
abbreviation for subsequent references; limit the change to this documentation
text.
In `@en/docs/next/ai-workspace/overview.md`:
- Around line 97-99: Rewrite the three policy bullets in the documentation so
each bold term is the grammatical subject of a short, complete sentence.
Preserve the existing meanings and details for Guardrails, Rate limits, and
Traffic and prompt policies, while following the documentation style
requirements for en/docs/**/*.md.
In `@en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md`:
- Around line 152-158: Update the AI Workspace secret configuration instructions
to map APIP_AIW_AUTH_OIDC_CLIENT_SECRET only into the BFF service, rather than
the shared api-platform.env used by both containers. Document the production
mounted-secret option at the BFF service level, including the
/secrets/ai-workspace/oidc_client_secret path, and ensure the Platform API does
not receive this credential.
In `@en/docs/next/ai-workspace/sync-gateway-created-artifacts.md`:
- Line 17: Update the gateway-created artifact description and the corresponding
references to clarify that gateway-owned runtime and deployment fields are
read-only, while users may edit runtime-neutral details such as descriptions,
documentation, OpenAPI definitions, and template connection details. Apply this
qualification consistently at all affected locations, including the artifact
guidance and later references.
---
Outside diff comments:
In `@en/docs/next/ai-workspace/ai-gateways/setting-up.md`:
- Around line 101-103: Align the archive and directory references in all three
installation methods with the downloaded v1.2.0-rc release: update every unzip
and cd command to use the -rc suffix consistently with the curl filename. Apply
this to the affected setup blocks without changing unrelated commands.
🪄 Autofix (Beta)
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: 3cff4b5e-9101-43d4-bd92-a5ffe045de58
📒 Files selected for processing (15)
en/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.mden/docs/next/ai-workspace/ci-cd/overview.mden/docs/next/ai-workspace/genai-applications.mden/docs/next/ai-workspace/getting-started.mden/docs/next/ai-workspace/insights.mden/docs/next/ai-workspace/llm-provider-templates/configure-template.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/overview.mden/docs/next/ai-workspace/policies/overview.mden/docs/next/ai-workspace/secrets-management.mden/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.mden/docs/next/ai-workspace/setting-up/authentication/overview.mden/docs/next/ai-workspace/sync-gateway-created-artifacts.md
…hrasing for guardrails, rate limits, and traffic policies. Clarify the ownership of AI artifacts in the sync gateway documentation. Enhance the description of user roles and scopes in the template configuration guide.
…g clarity, and ensuring consistency across sections. Update the overview of AI Workspace, clarify the use of secrets in configurations, and improve the explanation of user roles and artifact synchronization.
Contributor
Author
|
@coderabbitai review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
en/docs/next/ai-workspace/llm-provider-templates/configure-template.md (1)
69-71: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winSplit the versioning paragraph into short sentences.
Line 71 contains a sentence longer than 26 words and uses spaces around an em dash. Separate the edit, new-version, and provider-copy statements.
As per coding guidelines, use short sentences and em dashes without surrounding spaces. As per path instructions, apply these rules strictly in
en/docs/**/*.md.Suggested revision
-Custom template versions can be changed at any time: edit a version in place, or create a new version to introduce a different configuration while keeping the existing version available. Either way, providers already created from a version aren't affected — a provider copies the template configuration at creation time. +You can change custom template versions at any time. Edit a version in place. Create a new version when you need a different configuration while keeping the existing version available. Providers already created from a version aren't affected. A provider copies the template configuration at creation time.🤖 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/next/ai-workspace/llm-provider-templates/configure-template.md` around lines 69 - 71, Update the Versioning paragraph in the template documentation to use short, separate sentences for editing an existing custom version, creating a new version, and provider configuration copying. Remove spaces around the em dash while preserving the existing read-only built-in version behavior and meaning.Sources: Coding guidelines, Path instructions
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md (1)
65-69: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winAdd terminal punctuation to checklist sentences.
The security and deletion checklist items are complete sentences without periods. Add periods to each item on Lines 66–69 and 184–191.
As per coding guidelines, write complete sentences. As per path instructions, report Markdown documentation violations strictly in
en/docs/**/*.md.Also applies to: 184-191
🤖 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/next/ai-workspace/llm-proxies/manage-proxy.md` around lines 65 - 69, Update the checklist items in the “Security best practices” section and the corresponding deletion checklist to end each complete sentence with terminal periods, covering the referenced items at both locations.Sources: Coding guidelines, Path instructions
🤖 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/next/ai-workspace/ai-gateways/setting-up.md`:
- Around line 21-25: Clarify the scope requirements in the permissions list:
require ap:gateway:manage for adding, editing, or deleting gateways, or
ap:gateway:token:manage only when issuing registration tokens; explicitly
present these as alternatives rather than implying both scopes are required.
In `@en/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.md`:
- Line 90: Split the overlong sentences while preserving their technical meaning
and keeping every sentence under 26 words. Update
en/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.md:90,
en/docs/next/ai-workspace/genai-applications.md:19, and both affected sentences
in en/docs/next/ai-workspace/setting-up/authentication/overview.md:109-113.
In `@en/docs/next/ai-workspace/ci-cd/overview.md`:
- Around line 21-23: Define each acronym at its first use in all affected
guides: in en/docs/next/ai-workspace/ci-cd/overview.md lines 21-23, expand LLM
and MCP; in en/docs/next/ai-workspace/genai-applications.md line 19, expand LLM;
in en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md line
33, expand OIDC and PKCE; in
en/docs/next/ai-workspace/setting-up/authentication/overview.md lines 99-105,
expand OIDC, JWT, and JWKS; and in
en/docs/next/ai-workspace/sync-gateway-created-artifacts.md lines 17-22, expand
LLM and MCP. Preserve the existing abbreviations after their definitions and
apply the changes only under en/docs/**/*.md.
In `@en/docs/next/ai-workspace/getting-started.md`:
- Around line 68-69: Update the port-remapping tip near the docker-compose.yaml
example to explicitly instruct users to open the login URL with the remapped
host port, such as https://localhost:8443, instead of the default 9643. Keep the
container port and existing configuration-key guidance unchanged.
In `@en/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.md`:
- Around line 158-160: Update the authentication setup guidance so
APIP_AIW_AUTH_OIDC_CLIENT_SECRET is configured through a BFF-only environment
mapping for local deployments, not the shared api-platform.env file loaded by
both containers. Preserve the production instructions to mount the secret file
only on the AI Workspace service and use the config.toml file-based secret
reference.
In `@en/docs/next/ai-workspace/sync-gateway-created-artifacts.md`:
- Line 31: Update en/docs/next/ai-workspace/sync-gateway-created-artifacts.md
lines 31-31 and 331-331 to consistently state that gateway-controlled deployment
fields are read-only, while runtime-neutral details remain editable; revise both
descriptions without implying the entire AI Workspace copy is read-only.
---
Outside diff comments:
In `@en/docs/next/ai-workspace/llm-provider-templates/configure-template.md`:
- Around line 69-71: Update the Versioning paragraph in the template
documentation to use short, separate sentences for editing an existing custom
version, creating a new version, and provider configuration copying. Remove
spaces around the em dash while preserving the existing read-only built-in
version behavior and meaning.
In `@en/docs/next/ai-workspace/llm-proxies/manage-proxy.md`:
- Around line 65-69: Update the checklist items in the “Security best practices”
section and the corresponding deletion checklist to end each complete sentence
with terminal periods, covering the referenced items at both locations.
🪄 Autofix (Beta)
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: fd63fc89-5e8d-49ed-ab98-69e9219808c4
📒 Files selected for processing (15)
en/docs/next/ai-workspace/ai-gateways/setting-up.mden/docs/next/ai-workspace/ci-cd/configure-ci-cd-workflow.mden/docs/next/ai-workspace/ci-cd/overview.mden/docs/next/ai-workspace/genai-applications.mden/docs/next/ai-workspace/getting-started.mden/docs/next/ai-workspace/insights.mden/docs/next/ai-workspace/llm-provider-templates/configure-template.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/overview.mden/docs/next/ai-workspace/policies/overview.mden/docs/next/ai-workspace/secrets-management.mden/docs/next/ai-workspace/setting-up/authentication/asgardeo-setup.mden/docs/next/ai-workspace/setting-up/authentication/overview.mden/docs/next/ai-workspace/sync-gateway-created-artifacts.md
…pdating descriptions for large language model (LLM) providers and proxies, and improving instructions for port configuration and artifact management. Ensure consistency in terminology and formatting across multiple sections.
Contributor
Author
|
@CodeRabbit approve |
✅ Action performedComments resolved and changes approved. |
renuka-fernando
approved these changes
Aug 3, 2026
This was referenced Aug 4, 2026
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.
wso2/api-platform#2933