Update MI Copilot docs#2255
Open
IsuruMaduranga wants to merge 3 commits into
Open
Conversation
Replace the single mi-copilot.md page with a three-page subsection (overview, modes, features) and update the VS Code overview and AI code generation guide to describe Edit/Plan/Ask modes, sign-in options, and checkpoint-based workflow. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add 16 new screenshots for the WSO2 Integrator Copilot overview, modes, and features pages, and refresh the panel/sign-in screenshots for the new Copilot UI. Refine the Copilot doc pages to describe the per-turn and per-message checkpoints, adaptive thinking, and the full agent loop. Modernize the AI code generation guide to describe the new agent-mode flow (todo lists, tool call indicators, conversational build-and-run) instead of the old generate-and-add-to-project UI.
IsuruMaduranga
requested review from
anupama-pathirage,
chanikag and
rosensilva
as code owners
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummaryThis pull request updates WSO2 MI documentation to rebrand "MI Copilot" as "WSO2 Integrator Copilot" and adds comprehensive, user-facing documentation for the Copilot integrated in MI for VS Code. Key Changes
Impact and Review Notes
WalkthroughThe changes are documentation-only: they rename and reorganize MI Copilot content into a new WSO2 Integrator Copilot section, add three new pages (overview, modes, features), update navigation (en/mkdocs.yml), revise multiple guides and references (including an AI code-generation tutorial and data-mapper mediator docs), and remove content from the legacy mi-copilot page. Sequence Diagram(s)sequenceDiagram
participant User
participant VSCodePanel as "Copilot Panel (VS Code)"
participant CopilotBackend as "Copilot Backend"
participant Auth as "Auth Provider (WSO2/Anthropic/Bedrock)"
User->>VSCodePanel: open panel, sign in
VSCodePanel->>Auth: perform authentication
User->>VSCodePanel: send message + attachments (Ask/Edit/Plan)
VSCodePanel->>CopilotBackend: forward prompt, files
CopilotBackend->>VSCodePanel: stream response, tool calls, checkpoints
VSCodePanel->>User: render streamed output and checkpoint cards
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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}
Contributor
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/get-started/how-to-guides/ai-code-generation.md`:
- Around line 188-190: Replace the fenced code block that contains the text
"Build the project and start the server." with a Markdown indented code block
(prefix the line with four spaces) so it conforms to markdownlint code-block
style; locate the fenced block (``` ... ```) around that exact sentence and
convert it to an indented block instead of using backticks.
🪄 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: 6a8f7443-0d1e-4aa0-9ebf-d18eac2e940d
⛔ Files ignored due to path filters (20)
en/docs/assets/img/develop/mi-for-vscode/open-ai-panel.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/sign-in-to-copilot.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/adaptive-thinking-setting.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/ask-mode-add-to-project.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/attachments.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/checkpoint-card.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-checkpoint.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-todo-list.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/first-message-walkthrough.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mentions.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/message-checkpoint.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mode-switcher.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/model-settings.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/plan-approval-dialog.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/session-switcher.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/sign-in-options.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/thinking-segment.pngis excluded by!**/*.pngen/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/todo-list.pngis excluded by!**/*.pngen/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-open-ai-panel.pngis excluded by!**/*.pngen/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-sign-in-ai.pngis excluded by!**/*.png
📒 Files selected for processing (12)
en/docs/develop/create-integration-project.mden/docs/develop/creating-unit-test-suite.mden/docs/develop/intro-integration-development.mden/docs/develop/mi-for-vscode/mi-copilot.mden/docs/develop/mi-for-vscode/mi-for-vscode-overview.mden/docs/develop/mi-for-vscode/wso2-integrator-copilot/features.mden/docs/develop/mi-for-vscode/wso2-integrator-copilot/modes.mden/docs/develop/mi-for-vscode/wso2-integrator-copilot/overview.mden/docs/get-started/about-this-release.mden/docs/get-started/how-to-guides/ai-code-generation.mden/docs/reference/mediators/data-mapper-mediator.mden/mkdocs.yml
💤 Files with no reviewable changes (1)
- en/docs/develop/mi-for-vscode/mi-copilot.md
Comment on lines
+188
to
+190
| ``` | ||
| Build the project and start the server. | ||
| ``` |
Contributor
There was a problem hiding this comment.
Align the command example with markdownlint code-block rules.
Line 188 uses a fenced block without a language and conflicts with the configured code-block style. Converting this to an indented command block resolves both warnings.
Proposed fix
-```
-Build the project and start the server.
-```
+ Build the project and start the server.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ``` | |
| Build the project and start the server. | |
| ``` | |
| Build the project and start the server. |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 188-188: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 188-188: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🤖 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/get-started/how-to-guides/ai-code-generation.md` around lines 188 -
190, Replace the fenced code block that contains the text "Build the project and
start the server." with a Markdown indented code block (prefix the line with
four spaces) so it conforms to markdownlint code-block style; locate the fenced
block (``` ... ```) around that exact sentence and convert it to an indented
block instead of using backticks.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation set to reflect the renamed and expanded WSO2 Integrator Copilot experience in MI for VS Code, replacing the older “MI Copilot” docs and wiring in a new multi-page documentation section.
Changes:
- Replaces the single “MI Copilot” doc with a new WSO2 Integrator Copilot doc set (Overview / Modes / Features) and updates navigation accordingly.
- Updates cross-references across docs (Data Mapper, release notes, onboarding pages, unit-test docs) to point to the new Copilot docs.
- Refreshes the AI code generation tutorial to align with the newer Copilot workflow (modes, checkpoints, sign-in options, agent loop).
Reviewed changes
Copilot reviewed 12 out of 32 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| en/mkdocs.yml | Replaces the single “MI Copilot” nav item with a new “WSO2 Integrator Copilot” section (overview/modes/features). |
| en/docs/reference/mediators/data-mapper-mediator.md | Updates AI Data Mapper section to reference WSO2 Integrator Copilot and adjusts wording. |
| en/docs/get-started/how-to-guides/ai-code-generation.md | Rewrites the tutorial to match the new Copilot UX and agent workflow. |
| en/docs/get-started/about-this-release.md | Updates release notes to describe the new Copilot conversational modes and links to the new docs. |
| en/docs/develop/mi-for-vscode/wso2-integrator-copilot/overview.md | Adds the new Copilot overview page (panel entry points, sign-in, first message, anatomy). |
| en/docs/develop/mi-for-vscode/wso2-integrator-copilot/modes.md | Adds a new page documenting Ask/Edit/Plan modes with walkthroughs. |
| en/docs/develop/mi-for-vscode/wso2-integrator-copilot/features.md | Adds a new feature reference page (checkpoints, plan approval, attachments, sessions, models, quota). |
| en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md | Updates the MI for VS Code overview to describe and link to the new Copilot docs. |
| en/docs/develop/mi-for-vscode/mi-copilot.md | Removes the legacy MI Copilot page. |
| en/docs/develop/intro-integration-development.md | Updates the “MI Copilot” entry to “WSO2 Integrator Copilot” and links to the new overview page. |
| en/docs/develop/creating-unit-test-suite.md | Updates the AI sign-in note to reference WSO2 Integrator Copilot and links to the overview page. |
| en/docs/develop/create-integration-project.md | Updates the AI assistance link to point to the new Copilot overview page. |
Comments suppressed due to low confidence (3)
en/docs/get-started/how-to-guides/ai-code-generation.md:92
- This fenced code block is labeled as
yaml, but the content is Synapse XML. Please change the fence language toxmlso syntax highlighting is correct.
??? "WeatherEmailService API source"
=== "Source View"
```yaml
<api xmlns="http://ws.apache.org/ns/synapse" name="WeatherEmailService" context="/weatherEmail">
<resource methods="GET" uri-template="/getWeather?city={city}&email={email}">
<inSequence>
en/docs/get-started/how-to-guides/ai-code-generation.md:143
- This fenced code block is labeled as
yaml, but it contains XML (<?xml ...?>/<localEntry ...>). Please switch the fence language toxmlfor correct formatting/highlighting.
=== "Source View"
```yaml
<?xml version="1.0" encoding="UTF-8"?>
<localEntry key="EMAIL_CONN" xmlns="http://ws.apache.org/ns/synapse">
<email.init>
en/docs/get-started/how-to-guides/ai-code-generation.md:162
- This fenced code block is labeled as
yaml, but it contains XML (<?xml ...?>/<localEntry ...>). Please switch the fence language toxmlfor correct formatting/highlighting.
=== "Source View"
```yaml
<?xml version="1.0" encoding="UTF-8"?>
<localEntry key="OpenWeather" xmlns="http://ws.apache.org/ns/synapse">
<http.init>
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Press **Enter**. The Copilot opens a new chat session in **Edit mode** (the default) and starts working: | ||
|
|
||
| - You see the Copilot's reasoning stream in live, followed by **tool call indicators** (for example, *reading file*, *adding connector*, *writing `src/main/wso2mi/artifacts/apis/OrderAPI.xml`*). |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
chanikag
reviewed
May 22, 2026
| - MI Copilot: develop/mi-for-vscode/mi-copilot.md | ||
| - WSO2 Integrator Copilot: | ||
| - Overview: develop/mi-for-vscode/wso2-integrator-copilot/overview.md | ||
| - "Modes: Ask, Edit, and Plan": develop/mi-for-vscode/wso2-integrator-copilot/modes.md |
Contributor
There was a problem hiding this comment.
Suggested change
| - "Modes: Ask, Edit, and Plan": develop/mi-for-vscode/wso2-integrator-copilot/modes.md | |
| - Modes: Ask, Edit, and Plan: develop/mi-for-vscode/wso2-integrator-copilot/modes.md |
chanikag
reviewed
May 28, 2026
| - WSO2 MI for VSCode: | ||
| - "WSO2 Integrator: MI for VSCode Overview": develop/mi-for-vscode/mi-for-vscode-overview.md | ||
| - Troubleshooting MI for VS Code: develop/mi-for-vscode/troubleshooting-mi-for-vscode.md | ||
| - MI Copilot: develop/mi-for-vscode/mi-copilot.md |
Contributor
There was a problem hiding this comment.
If this is removed, we need to add redirections. Otherwise it will give 404 when switch to latest version from a previous version (and old links)
chanikag
reviewed
May 28, 2026
| - ai | ||
| --- | ||
|
|
||
| # Features |
Contributor
There was a problem hiding this comment.
Let's say WSO2 integrator copilot features. Otherwise when someone lands directly into this page, that does not give clear picture on what this content is about.
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
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.
No description provided.