Add AI Workspace DP to CP docs#327
Conversation
📝 WalkthroughAdded a new AI Workspace documentation guide for bottom-up AI artifact deployment from AI Gateway. The guide explains:
WalkthroughThis pull request adds a new documentation page describing bottom-up AI artifact deployment, explaining how artifacts created directly on an AI Gateway (LLM Provider Templates, LLM Providers, LLM Proxies, and MCP Proxies) are automatically synced to the AI Workspace as read-only copies. The guide covers prerequisites, the Sequence Diagram(s)Not applicable — this change is documentation-only and does not introduce or modify functional control flow. Suggested reviewers: 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 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: 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/bottom-up-ai-artifact-deployment-guide.md`:
- Around line 65-68: The fenced ASCII diagram in the documentation is unlabeled,
which triggers markdownlint MD040. Update the affected diagram blocks in the
guide to use a text/plaintext fence label, or convert them to a non-fenced
block, and apply the same fix to the other matching diagram block referenced in
the comment so the docs lint passes cleanly.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7fec275b-9a80-4390-88f2-ddc94c14c92a
📒 Files selected for processing (1)
en/docs/next/ai-workspace/bottom-up-ai-artifact-deployment-guide.md
| ``` | ||
| Create on the gateway ─┬─▶ takes effect immediately (starts serving traffic) | ||
| └─▶ synced to the AI Workspace ─▶ appears as a read-only copy | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Label the plain fenced diagrams.
These unlabeled fences are triggering markdownlint MD040. Mark them as text/plaintext, or use a non-fenced block, so the docs lint passes cleanly.
Also applies to: 117-119
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 65-65: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/bottom-up-ai-artifact-deployment-guide.md` around
lines 65 - 68, The fenced ASCII diagram in the documentation is unlabeled, which
triggers markdownlint MD040. Update the affected diagram blocks in the guide to
use a text/plaintext fence label, or convert them to a non-fenced block, and
apply the same fix to the other matching diagram block referenced in the comment
so the docs lint passes cleanly.
Source: Linters/SAST tools
1 participant
This pull request adds a comprehensive new guide to the documentation that explains how AI artifacts created on the AI Gateway are automatically synced to the AI Workspace as read-only copies. The guide covers the bottom-up sync process, including prerequisites, enabling and troubleshooting sync, supported artifact types, and detailed steps for creating and managing these artifacts.
New documentation: Bottom-up AI artifact sync
bottom-up-ai-artifact-deployment-guide.md, detailing how to create AI artifacts (LLM Provider Template, LLM Provider, LLM Proxy, MCP Proxy) on the gateway and how they are synced as read-only copies to the AI Workspace.