Improve docs for the release - #378
Conversation
📝 WalkthroughWalkthroughThe documentation updates move Gateway Controller Management API examples from v0.9/v1alpha1 to v1. AI Workspace guidance now documents header-only API-key authentication, updated provider navigation, chip-based model management, and redeployment after model changes. ChangesGateway Management API v1 documentation
AI Workspace configuration documentation
Estimated code review effort: 2 (Simple) | ~15 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 |
|
Naduni Pamudika seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
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/api-gateway/next/gateway-controller-management-api/websub-api-management.md (1)
635-635: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winCapitalize
IDin the heading.Use sentence case and the standard acronym capitalization:
Proposed wording
-## Get WebSubAPI by id +## Get a WebSub API by ID🤖 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/api-gateway/next/gateway-controller-management-api/websub-api-management.md` at line 635, Update the heading “Get WebSubAPI by id” to capitalize the acronym as “ID” while preserving sentence case.Source: 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/api-gateway/next/gateway-controller-management-api/llm-provider-management.md`:
- Line 381: Format both the apiVersion field name and its case-sensitive version
value as inline code in the rows at
en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-management.md:381,
llm-provider-template-management.md:313, llm-proxy-management.md:260,
mcp-proxy-management.md:320, rest-api-management.md:430, and
webbroker-api-management.md:390.
In
`@en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-template-management.md`:
- Around line 78-90: Update the “Using a YAML downloaded from AI Workspace”
admonition so the curl example is represented with a lint-recognized fenced code
block rather than an indented code block. Preserve the existing command and
admonition guidance, using the repository-approved MkDocs nested-fence pattern
or placing the fence outside the admonition.
In `@en/docs/cloud/ai-workspace/configure-inbound-auth.md`:
- Line 31: Remove the timeless “Currently” wording and state that header is the
only supported option in all affected descriptions:
en/docs/cloud/ai-workspace/configure-inbound-auth.md:31-31,
en/docs/next/ai-workspace/configure-inbound-auth.md:31-31,
en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md:148-148,
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md:148-148,
en/docs/cloud/ai-workspace/llm-providers/manage-provider.md:136-136, and
en/docs/next/ai-workspace/llm-providers/manage-provider.md:146-146. Use the
wording “The only supported option is `header`.” while preserving each table’s
existing field labels.
In `@en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md`:
- Around line 147-149: Insert a blank line between the final row of the
authentication table and numbered Save step 3 in both
en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md lines 147-149 and
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md lines 147-150; no other
content changes are needed.
In `@en/docs/next/ai-workspace/llm-providers/manage-provider.md`:
- Line 147: Update the “API Key Value Prefix” table description in
manage-provider.md to use the requested grammatical wording: describe it as an
optional prefix prepended to the key value, such as `Bearer`, so clients send
`Bearer <key>`.
---
Outside diff comments:
In
`@en/docs/api-gateway/next/gateway-controller-management-api/websub-api-management.md`:
- Line 635: Update the heading “Get WebSubAPI by id” to capitalize the acronym
as “ID” while preserving sentence case.
🪄 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: 7857b47e-abaa-49e5-a7ad-0361b98feace
📒 Files selected for processing (19)
en/docs/api-gateway/next/gateway-controller-management-api/certificate-management.mden/docs/api-gateway/next/gateway-controller-management-api/llm-provider-management.mden/docs/api-gateway/next/gateway-controller-management-api/llm-provider-template-management.mden/docs/api-gateway/next/gateway-controller-management-api/llm-proxy-management.mden/docs/api-gateway/next/gateway-controller-management-api/mcp-proxy-management.mden/docs/api-gateway/next/gateway-controller-management-api/overview.mden/docs/api-gateway/next/gateway-controller-management-api/rest-api-management.mden/docs/api-gateway/next/gateway-controller-management-api/schemas.mden/docs/api-gateway/next/gateway-controller-management-api/secrets-management.mden/docs/api-gateway/next/gateway-controller-management-api/webbroker-api-management.mden/docs/api-gateway/next/gateway-controller-management-api/websub-api-management.mden/docs/cloud/ai-workspace/configure-inbound-auth.mden/docs/cloud/ai-workspace/llm-providers/configure-provider.mden/docs/cloud/ai-workspace/llm-providers/manage-provider.mden/docs/cloud/ai-workspace/llm-proxies/manage-proxy.mden/docs/next/ai-workspace/configure-inbound-auth.mden/docs/next/ai-workspace/llm-providers/configure-provider.mden/docs/next/ai-workspace/llm-providers/manage-provider.mden/docs/next/ai-workspace/llm-proxies/manage-proxy.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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-proxies/manage-proxy.md`:
- Line 148: Update the “Sent in” table entry in the proxy documentation to
remove the temporal word “Currently,” leaving `header` described as the only
supported option while preserving the rest of the wording and 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: 19bc9f29-28e9-45bc-be9b-935e7950922e
📒 Files selected for processing (1)
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md
Summary
apiVersionvalueTest plan
Fixes related to wso2/api-platform#2933 (comment), wso2/api-platform#2933 (comment) and wso2/api-platform#2933 (comment)