AI-Powered, low-code friendly Document Generation for both BI and MI connectors

[vishwajayawickrama]

Area

None

Problem

Ballerina maintains over 400 connectors, but their documentation is primarily designed for a pro-code, developer-centric audience. While comprehensive for code-based integration, it cannot be directly used within Ballerina Integrator (BI) and WSO2 Micro Integrator (MI), which emphasize a low-code, visual experience.

Proposed Solution

This project proposes an AI-driven framework to automate the generation of documentation with visual elements (such as screenshots and GIFs) and examples for Ballerina Integrator (BI) and WSO2 Micro Integrator (MI) connectors.

The framework will use AI agents to transform pro-code assets into low-code-friendly documentation, making all 400+ connectors accessible to BI and MI users. Using developer-defined scenarios, it will generate structured guides, step-by-step procedures, and visually enriched integration examples aligned with existing MI documentation standards.

Key Features to Implement

• AI-Driven Connector Documentation Generation
  Develop an AI agent to generate comprehensive, low-code-friendly documentation, including setup and quick-start guides for common use cases, using developer-provided scenarios to guide the output.

• AI-Driven Connector API Reference Guide
  Extract the Ballerina API documentation to generate a reference guide specifically for the BI and MI editor, including sample inputs and outputs for each operation to assist in data mapping.

• AI-Powered Example Generation
  Develop an AI agent capable of generating end-to-end integrations using BI low-code mode for developer-specified scenarios, structured with individual steps and screenshot placeholders.

Alternatives

No response

Version

No response