Skip to content

Add AI data mapping documentation and cross-link Auto Map references#399

Open
VellummyilumVinoth wants to merge 10 commits into
wso2:mainfrom
VellummyilumVinoth:ai-data-mapping
Open

Add AI data mapping documentation and cross-link Auto Map references#399
VellummyilumVinoth wants to merge 10 commits into
wso2:mainfrom
VellummyilumVinoth:ai-data-mapping

Conversation

@VellummyilumVinoth
Copy link
Copy Markdown
Contributor

@VellummyilumVinoth VellummyilumVinoth commented May 13, 2026

Description

  • Adds a new ai-data-mapper.md page documenting the AI data mapping feature, including a Visual designer tab with step-by-step screenshots (canvas, Copilot command, result) and a Ballerina code tab showing before/after transformation code.
  • Simplifies the Map with AI section in mapping-capabilities.md to a brief description with a link to the new page, removing duplicated content.
  • Removes the outdated ai-assisted-data-mapping.md file (stale references to Ballerina Copilot and deprecated UI behaviour) and replaces its inbound link in expressions-functions.md.
  • Adds three step-by-step screenshots extracted from the feature recording.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Expanded guidance on using AI-assisted data mapping for complex schemas.
    • Rewrote "Map with AI" instructions with clearer steps for accessing the Auto Map feature.
    • Added new comprehensive AI data mapping documentation page with usage examples and feature details.
    • Updated navigation menu to include AI data mapping documentation.
    • Enhanced data mapper editor guidance to reference AI mapping capabilities.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This pull request introduces a new AI Data Mapping documentation page and integrates it across the documentation suite. The new page provides comprehensive guidance on using automated AI-powered field mapping in WSO2 Integrator, with UI workflows and Ballerina code examples. Existing documentation in data mapper, copilot, and flow editor contexts is updated to link to and reference this new resource.

Changes

AI Data Mapping Documentation Suite

Layer / File(s) Summary
AI Data Mapping documentation page
en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md
New comprehensive page covering AI Data Mapping overview, UI and code-based usage steps with example Ballerina record types and transform functions, feature descriptions (automated mapping, advanced expressions, sub-mapping reuse), responsible-use guidance, and navigation to related Data Mapper and expression documentation.
Sidebar navigation and Copilot overview updates
en/sidebars.ts, en/docs/develop/copilot/overview.md
Sidebar configuration adds the new AI Data Mapping page under Data Mapper sub-items. Copilot overview updates /datamap command link and "AI data mapper" See also entry to point to the new ai-mapping page.
Data Mapper documentation guidance and links
en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md, en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md, en/docs/develop/understand-ide/editors/datamapper-editor.md
"Bootstrap a complex mapping quickly" guidance in data-mapper.md mentions Auto Map and AI data mapping for large schemas. Mapping capabilities "Map with AI" section is rewritten with Auto Map steps and links to AI Data Mapping walkthrough. "What's next" list adds AI data mapping. Datamapper editor Auto Map section links to AI data mapping documentation.
Flow Diagram Editor statement documentation updates
en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md
Map Data section explicitly links Auto Map to AI data mapper documentation. Call Function picker label "Within Project" formatting adjusted to literal style.

Possibly related PRs

  • wso2/docs-integrator#384: Updates Copilot documentation including /datamap command behavior, directly connected to this PR's link target changes in overview.md.
  • wso2/docs-integrator#423: Updates Data Mapper documentation to reference AI-assisted mapping and mapping capabilities, aligning with this PR's cross-document linking strategy.
  • wso2/docs-integrator#420: Modifies the same Data Mapper editor documentation, changing Auto Map navigation and link targets.

Suggested reviewers

  • rosensilva
  • NipunaRanasinghe
  • KavinduZoysa
  • anupama-pathirage

Poem

🐰 A mapper's map now with AI's grace,
New docs light the way through data's space,
Auto Map flows where guidance leads,
Cross-linked breadcrumbs for all your needs! ✨

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description contains only a 'Description' section with actual content; remaining required template sections are empty placeholder headings with no substantive information. Complete required sections including Purpose/Goals, Approach, Release note, Documentation impact, and other applicable template fields with specific details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding AI data mapping documentation and updating Auto Map cross-references throughout the codebase.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md`:
- Around line 93-96: Update the misspelled field name in the Accommodation
record and any generated mapping code: change numberOfRoomates to
numberOfRoommates in the type declaration (type Accommodation record { ... })
and update the corresponding mapping logic that references numberOfRoomates so
it uses numberOfRoommates instead; ensure all occurrences (type definition and
generated mapper) are renamed consistently to avoid breaking consumers.
🪄 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: CHILL

Plan: Pro

Run ID: 11d8519b-71d9-4277-8c99-8b62e79add45

📥 Commits

Reviewing files that changed from the base of the PR and between 8eb091c and d739163.

⛔ Files ignored due to path filters (3)
  • en/static/img/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper-canvas.png is excluded by !**/*.png
  • en/static/img/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper-copilot-command.png is excluded by !**/*.png
  • en/static/img/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper-result.png is excluded by !**/*.png
📒 Files selected for processing (8)
  • en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md
  • en/docs/develop/transform/ai-assisted-data-mapping.md
  • en/docs/develop/transform/expressions-functions.md
  • en/docs/develop/understand-ide/editors/datamapper-editor.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md
  • en/sidebars.ts
💤 Files with no reviewable changes (1)
  • en/docs/develop/transform/ai-assisted-data-mapping.md

@VellummyilumVinoth VellummyilumVinoth force-pushed the ai-data-mapping branch 3 times, most recently from 6f2bac1 to 34cc0d5 Compare May 13, 2026 10:20
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/understand-ide/editors/datamapper-editor.md Outdated
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md`:
- Around line 1-6: The page filename ai-data-mapper.md repeats the parent
directory keyword and doesn't align the slug with the title "AI Data Mapping";
rename the file to a shorter slug such as ai-mapping.md, update any inbound
links and sidebar references that point to the old ai-data-mapper path
(including sidebars, TOCs, and cross-doc links), and ensure the frontmatter
title remains "AI Data Mapping" so title and URL keywords match; also search for
occurrences of "ai-data-mapper" in the repo and update them to the new slug to
avoid broken links.
🪄 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: CHILL

Plan: Pro

Run ID: c423180b-5205-4863-b6d6-314a0f65431e

📥 Commits

Reviewing files that changed from the base of the PR and between 6f2bac1 and 476f734.

⛔ Files ignored due to path filters (3)
  • en/static/img/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper-canvas.png is excluded by !**/*.png
  • en/static/img/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper-copilot-command.png is excluded by !**/*.png
  • en/static/img/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper-result.png is excluded by !**/*.png
📒 Files selected for processing (7)
  • en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md
  • en/docs/develop/transform/ai-assisted-data-mapping.md
  • en/docs/develop/understand-ide/editors/datamapper-editor.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md
  • en/sidebars.ts
💤 Files with no reviewable changes (1)
  • en/docs/develop/transform/ai-assisted-data-mapping.md
✅ Files skipped from review due to trivial changes (3)
  • en/docs/develop/understand-ide/editors/datamapper-editor.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md
  • en/sidebars.ts
🚧 Files skipped from review as they are similar to previous changes (2)
  • en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md (1)

1-6: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win

Filename still violates hierarchy redundancy rule.

The filename ai-data-mapper.md repeats the parent directory keyword data-mapper, violating the coding guideline: "If a keyword exists in the parent directory, do not repeat it in the URL slug." Rename this file to a shorter slug such as ai-mapping.md and update the inbound link in statement.md (line 56) accordingly.

As per coding guidelines: "Check the file path/hierarchy. If a keyword exists in the parent directory, do not repeat it in the URL slug."

🤖 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/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md`
around lines 1 - 6, The file ai-data-mapper.md repeats the parent directory
keyword and should be renamed to ai-mapping.md; rename the document slug/file
from ai-data-mapper.md to ai-mapping.md and update the inbound link in
statement.md to point to the new slug (replace any references to
"ai-data-mapper" with "ai-mapping") so the URL hierarchy no longer repeats the
parent directory keyword.
🤖 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.

Duplicate comments:
In
`@en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md`:
- Around line 1-6: The file ai-data-mapper.md repeats the parent directory
keyword and should be renamed to ai-mapping.md; rename the document slug/file
from ai-data-mapper.md to ai-mapping.md and update the inbound link in
statement.md to point to the new slug (replace any references to
"ai-data-mapper" with "ai-mapping") so the URL hierarchy no longer repeats the
parent directory keyword.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b84650a5-2879-4166-940b-0232b36efc6e

📥 Commits

Reviewing files that changed from the base of the PR and between 476f734 and cf7227b.

📒 Files selected for processing (5)
  • en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md
  • en/docs/develop/understand-ide/editors/datamapper-editor.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md
✅ Files skipped from review due to trivial changes (3)
  • en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md
  • en/docs/develop/understand-ide/editors/datamapper-editor.md
  • en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md

Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-data-mapper.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Comment thread en/docs/develop/integration-artifacts/supporting/data-mapper/ai-mapping.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants