Fix: Update connector import documentation [main]#2083
Fix: Update connector import documentation [main]#2083wso2-engineering-bot wants to merge 1 commit intomainfrom
Conversation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
WalkthroughDocumentation update to the connector import workflow in WSO2 Integration Studio. The guide shifts from a Connector Store-based approach to a mediation-flow-centric workflow, introduces a new import connections method, updates visual assets to GIF format, and removes references to legacy import options. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip CodeRabbit can generate a title for your PR based on the changes.Add |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
en/docs/develop/creating-artifacts/adding-connectors.md (1)
38-46: Consider adding clarifying text to distinguish Methods 2 and 3.Method 2 is titled "Import connectors" while Method 3 is "Import connections". The distinction between importing a "connector" versus a "connection" may not be immediately clear to users. Consider adding a brief introductory sentence to Method 3 explaining when to use this method versus Method 2.
📝 Suggested clarification
Add a brief explanation before step 1, for example:
#### Method 3: Import connections + +Use this method to generate connection artifacts from API definitions. 1. Navigate to the **Project Overview** page.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/docs/develop/creating-artifacts/adding-connectors.md` around lines 38 - 46, Add a short clarifying sentence before the numbered steps for "Method 3: Import connections" that explicitly distinguishes it from "Method 2: Import connectors" — mention that Method 2 imports prebuilt connector packages (connectors) from the connector catalog while Method 3 imports individual connection definitions (OpenAPI or gRPC/Proto files) to create a new connection; reference the headings "Method 2: Import connectors" and "Method 3: Import connections" so the user knows when to choose each method.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@en/docs/develop/creating-artifacts/adding-connectors.md`:
- Around line 38-46: Add a short clarifying sentence before the numbered steps
for "Method 3: Import connections" that explicitly distinguishes it from "Method
2: Import connectors" — mention that Method 2 imports prebuilt connector
packages (connectors) from the connector catalog while Method 3 imports
individual connection definitions (OpenAPI or gRPC/Proto files) to create a new
connection; reference the headings "Method 2: Import connectors" and "Method 3:
Import connections" so the user knows when to choose each method.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ffefb726-c6cd-4502-801b-3ae3a78b6181
⛔ Files ignored due to path filters (2)
en/docs/assets/img/integrate/connectors/import-connection.pngis excluded by!**/*.pngen/docs/assets/img/integrate/connectors/import-connector.gifis excluded by!**/*.gif
📒 Files selected for processing (1)
en/docs/develop/creating-artifacts/adding-connectors.md
This PR was automatically generated by Claude AI.
Summary by CodeRabbit