Add AI Data Mapping user guide #195
Conversation
VellummyilumVinoth
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
WalkthroughThis PR adds an AI Data Mapper documentation page, renames the existing Data Mapping guide to Manual Data Mapping (updating images/links), updates related cross-links, and changes mkdocs navigation to expose Manual and AI Data Mapping as sub-pages under Data Mapping. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 0
🧹 Nitpick comments (4)
en/docs/developer-guides/data-mapping/manual-data-mapping.md (1)
134-143: Consider improving section title clarity and addressing linter feedback.The section "AI data mapping" (line 134) describes the AI-assisted Auto Map feature within the manual mapper, which may cause confusion with the separate AI Data Mapping guide. While the content is accurate, the section header could be renamed to "Auto Mapping with AI Assistance" for clarity. Additionally, the static analysis tool flagged excessive exclamation marks in this vicinity; review the overall tone across this section to ensure documentation maintains a professional, measured voice.
Consider renaming for clarity:
-### AI data mapping +### Auto Mapping with AI Assistanceen/docs/developer-guides/data-mapping/ai-data-mapping.md (3)
17-18: Improve sentence variety to enhance readability.Three consecutive sentences begin with "It's," which reduces impact and readability. The static analysis tool flagged this as a style concern.
Suggested revision:
-It's slow. It's error-prone. It eats weeks of developer time. +It's slow and error-prone, consuming weeks of developer time.Alternatively:
-It's slow. It's error-prone. It eats weeks of developer time. +Slow. Error-prone. Time-consuming. Traditional data mapping drains developer weeks.
60-60: Use hyphenation for compound adjectives.Line 60: "Array to array mappings" should be "Array-to-array mappings" when used as a compound adjective modifying "mappings."
-- **Array to array mappings**: Element-wise transformations with proper iteration +- **Array-to-array mappings**: Element-wise transformations with proper iteration
158-159: Fix sentence structure and remove duplication.Lines 158–159 contain awkward phrasing and duplication. The phrase "we're continuously improving based on real-world usage" appears twice in slightly different forms, disrupting flow.
Current:
"We're continuously improving based on real-world usage. Share your feedback, suggestions, or issues through the Ballerina community channels we're continuously improving based on your real-world usage."
Suggested fix:
-We're continuously improving based on real-world usage. Share your feedback, suggestions, or issues through the [Ballerina community channels](https://ballerina.io/community/) we're continuously improving based on your real-world usage. +We're continuously improving based on your real-world usage. Share your feedback, suggestions, or issues through the [Ballerina community channels](https://ballerina.io/community/).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (19)
en/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/ai-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/claim-submission-to-international401-claim.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/hl7v23-pid-to-international401-patient.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/manual-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-inline-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-return.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/array-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/auto-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-new-type.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-service.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-resource.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/inline-data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/many-to-one-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/simple-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/type-from-json.gifis excluded by!**/*.gif
📒 Files selected for processing (5)
en/docs/developer-guides/data-mapping/ai-data-mapping.md(1 hunks)en/docs/developer-guides/data-mapping/manual-data-mapping.md(7 hunks)en/docs/index.md(2 hunks)en/docs/integration-guides/usecases/datamapper/overview.md(1 hunks)en/mkdocs.yml(1 hunks)
🧰 Additional context used
🪛 LanguageTool
en/docs/developer-guides/data-mapping/ai-data-mapping.md
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tandards. It's slow. It's error-prone. It eats weeks of developer time. And every...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~59-~59: Consider a different adjective to strengthen your wording.
Context: ...ull-safety checks - Nested records: Deep structure transformations - **Array to ...
(DEEP_PROFOUND)
[grammar] ~60-~60: Use a hyphen to join words.
Context: ...p structure transformations - Array to array mappings: Element-wise transform...
(QB_NEW_EN_HYPHEN)
en/docs/developer-guides/data-mapping/manual-data-mapping.md
[style] ~140-~140: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 5621 characters long)
Context: ...f" alt="Auto Mapping" width="70%"> !!! info "AI Data Mapper" To learn more...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (6)
en/docs/developer-guides/data-mapping/ai-data-mapping.md (3)
85-99: Verify Ballerina code example is correct and production-ready.The sub-mapping reuse example (lines 85–99) demonstrates a transformation function. Ensure this code:
- Compiles without errors
- Correctly demonstrates the intended sub-mapping reuse pattern
- Is idiomatic Ballerina
Can you confirm the code example compiles and accurately represents how the AI Data Mapper would generate and reuse such expressions?
120-129: Verify that healthcare examples are representative and accurate.The PR references resolving issue #1883, which calls for comprehensive blog posts with real healthcare examples. This guide includes two healthcare examples (ClaimSubmission → international401:Claim and hl7v23:PID → international401:Patient).
Confirm:
- The schemas and transformations shown are realistic healthcare use cases
- The GIFs/visual examples accurately depict the AI Data Mapper behavior
- The external links to Ballerina Central (international401:Claim, hl7v23:PID) are current
1-165: Clarify alignment between documentation guide and PR objectives.The PR description references issue #1883, which calls for two comprehensive blog posts: one internal (developer perspective) and one external (user perspective). This file reads as a polished user/product guide rather than a blog post.
Confirm whether:
- This guide is intended to replace or supplement the planned blog posts
- Separate blog post artifacts are planned or already exist
- The structure and tone align with the stated objectives for external user-facing documentation
en/docs/index.md (1)
20-20: Navigation links updated appropriately.The Data Mapping link now correctly points to the manual-data-mapping subdirectory (line 20), and the new AI Data Mapping link has been added to the AI tile (line 37). The trailing slash consistency on line 36 also improves uniformity. Changes align well with the mkdocs.yml restructuring.
Also applies to: 36-37
en/docs/integration-guides/usecases/datamapper/overview.md (1)
43-43: Data Mapping link correctly updated for new nested structure.The link has been updated to point to the manual-data-mapping subdirectory, aligning with the reorganized documentation hierarchy. The relative path is correct.
en/mkdocs.yml (1)
112-114: Navigation structure correctly nested for Manual and AI Data Mapping guides.The Data Mapping section is now properly nested with Manual Data Mapping and AI Data Mapping as sub-entries. YAML indentation and syntax appear correct. Ensure any legacy data-mapping.md file (if it existed) has been removed to prevent navigation conflicts.
Please confirm:
- The mkdocs build succeeds with this navigation structure
- Any previous data-mapping.md file at the root level has been removed or replaced
VellummyilumVinoth
force-pushed
the
datamapper-doc
branch
from
99861ee to
5a3715f
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
en/docs/developer-guides/data-mapping/ai-data-mapping.md (2)
38-122: Minor wording suggestion: Replace "prior to" with shorter alternative.Line 113 uses "prior to output" which is slightly wordy. Consider "All generated mappings are validated by the Ballerina Language Server before output, ensuring:" for improved conciseness.
131-131: Grammar: Ensure proper hyphenation in "Standard to standard format" heading.The heading "Standard to standard format" may benefit from a hyphen as compound adjective: "Standard-to-standard format". Similarly, check that "hl7v23:PID" is formatted consistently with style conventions. Refer to LanguageTool feedback for guidance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (19)
en/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/ai-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/claim-submission-to-international401-claim.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/hl7v23-pid-to-international401-patient.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/manual-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-inline-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-return.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/array-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/auto-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-new-type.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-service.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-resource.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/inline-data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/many-to-one-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/simple-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/type-from-json.gifis excluded by!**/*.gif
📒 Files selected for processing (5)
en/docs/developer-guides/data-mapping/ai-data-mapping.md(1 hunks)en/docs/developer-guides/data-mapping/manual-data-mapping.md(7 hunks)en/docs/index.md(2 hunks)en/docs/integration-guides/usecases/datamapper/overview.md(1 hunks)en/mkdocs.yml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- en/docs/index.md
- en/docs/integration-guides/usecases/datamapper/overview.md
- en/mkdocs.yml
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-12T05:34:18.459Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/os-level-security.md:1-25
Timestamp: 2025-11-12T05:34:18.459Z
Learning: In the WSO2 docs-bi repository, specifically in deployment best practices documentation files under en/docs/deploy/deployment-best-practices/, using h3 (###) headings directly after h1 titles (instead of h2) is intentional and should not be flagged.
Applied to files:
en/docs/developer-guides/data-mapping/ai-data-mapping.md
📚 Learning: 2025-11-12T05:34:19.589Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/network-level-security.md:1-20
Timestamp: 2025-11-12T05:34:19.589Z
Learning: In the wso2/docs-bi repository documentation files, using h3 (###) subsection headings directly under h1 (#) titles is an intentional style choice, even though it violates standard markdown heading increment rules.
Applied to files:
en/docs/developer-guides/data-mapping/ai-data-mapping.md
🪛 LanguageTool
en/docs/developer-guides/data-mapping/manual-data-mapping.md
[style] ~140-~140: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 5621 characters long)
Context: ...f" alt="Auto Mapping" width="70%"> !!! info "AI Data Mapper" To learn more...
(EN_EXCESSIVE_EXCLAMATION)
en/docs/developer-guides/data-mapping/ai-data-mapping.md
[style] ~113-~113: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...idated by the Ballerina Language Server prior to output, ensuring: - Syntactic correctn...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[grammar] ~131-~131: Use a hyphen to join words.
Context: ...dth="70%"> ### Example 2: Standard to standard format ([hl7v23:PID](https:/...
(QB_NEW_EN_HYPHEN)
[grammar] ~131-~131: Use a hyphen to join words.
Context: ...="70%"> ### Example 2: Standard to standard format ([hl7v23:PID](https://ce...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (4)
en/docs/developer-guides/data-mapping/ai-data-mapping.md (2)
1-39: Heading structure and introductory content look good.The page title is clear, and the introductory sections correctly use h3 headings (skipping h2), which aligns with WSO2 docs-bi style. The healthcare and financial integration examples are concrete and relevant. The cross-reference to the manual data mapper on line 5 is correct.
125-125: Verify external FHIR type references align with documentation strategy.Lines 125 and 131 link directly to Ballerina Central for FHIR types (
international401:Claim,hl7v23:PID,international401:Patient). Based on previous feedback, consider whether these should be internal BI documentation references instead. If external links are intentional for technical reference, this is acceptable; otherwise, align with the strategy of pointing to BI docs.Also applies to: 131-131
en/docs/developer-guides/data-mapping/manual-data-mapping.md (2)
131-142: New AI data mapping section is well-integrated.The addition of the "AI data mapping" subsection (lines 134-142) appropriately replaces the previous "Auto Map" terminology. The cross-reference to the AI Data Mapper guide and the info box with the Copilot mention integrate smoothly. The image path has been correctly updated to the
manual-data-mappingdirectory.
112-170: All remaining image path updates are consistent and complete.Lines 112, 122, 124, 148, 154, 161, and 170 all have image paths correctly migrated from the
data-mappingtomanual-data-mappingsubdirectory. Image alt text is preserved, and the updates align with the file rename and directory reorganization. No content changes have been introduced.
VellummyilumVinoth
force-pushed
the
datamapper-doc
branch
from
5a3715f to
4f39081
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/docs/developer-guides/data-mapping/ai-data-mapping.md (1)
112-112: Minor: Consider more direct wording.The phrase "prior to output" can be simplified to "before output" for more direct technical documentation style.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (19)
en/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/ai-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/claim-submission-to-international401-claim.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/hl7v23-pid-to-international401-patient.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/manual-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-inline-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-return.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/array-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/auto-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-new-type.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-service.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-resource.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/inline-data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/many-to-one-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/simple-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/type-from-json.gifis excluded by!**/*.gif
📒 Files selected for processing (5)
en/docs/developer-guides/data-mapping/ai-data-mapping.md(1 hunks)en/docs/developer-guides/data-mapping/manual-data-mapping.md(7 hunks)en/docs/index.md(2 hunks)en/docs/integration-guides/usecases/datamapper/overview.md(1 hunks)en/mkdocs.yml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- en/docs/integration-guides/usecases/datamapper/overview.md
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-12T05:34:18.459Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/os-level-security.md:1-25
Timestamp: 2025-11-12T05:34:18.459Z
Learning: In the WSO2 docs-bi repository, specifically in deployment best practices documentation files under en/docs/deploy/deployment-best-practices/, using h3 (###) headings directly after h1 titles (instead of h2) is intentional and should not be flagged.
Applied to files:
en/docs/developer-guides/data-mapping/ai-data-mapping.md
📚 Learning: 2025-11-12T05:34:19.589Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/network-level-security.md:1-20
Timestamp: 2025-11-12T05:34:19.589Z
Learning: In the wso2/docs-bi repository documentation files, using h3 (###) subsection headings directly under h1 (#) titles is an intentional style choice, even though it violates standard markdown heading increment rules.
Applied to files:
en/docs/developer-guides/data-mapping/ai-data-mapping.md
🪛 LanguageTool
en/docs/developer-guides/data-mapping/manual-data-mapping.md
[style] ~140-~140: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 5621 characters long)
Context: ...f" alt="Auto Mapping" width="70%"> !!! info "AI Data Mapper" To learn more...
(EN_EXCESSIVE_EXCLAMATION)
en/docs/developer-guides/data-mapping/ai-data-mapping.md
[style] ~112-~112: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...idated by the Ballerina Language Server prior to output, ensuring: - Syntactic correctn...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[grammar] ~129-~129: Use a hyphen to join words.
Context: ...idth="70%"> ### Example 2: Standard to standard format ([hl7v23:PID](https:/...
(QB_NEW_EN_HYPHEN)
[grammar] ~129-~129: Use a hyphen to join words.
Context: ...h="70%"> ### Example 2: Standard to standard format ([hl7v23:PID](https://ce...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (5)
en/docs/index.md (1)
20-20: Navigation updates correctly reflect new documentation structure.The changes to link Data Mapping to manual-data-mapping and the addition of AI Data Mapping in the appropriate tiles align with the documentation restructuring. The URL formatting is consistent.
Also applies to: 36-37
en/docs/developer-guides/data-mapping/ai-data-mapping.md (2)
37-37: Fix heading capitalization and terminology consistency.Line 37 uses "AI datamapper features" but should align with the consistent terminology used throughout the document: "AI Data Mapper features". Additionally, "datamapper" should be two words ("data mapper") to match the pattern in other section headings and follow sentence case conventions.
[raise_essential_issue]
Apply this diff:-## AI datamapper features +## AI Data Mapper features
5-5: Verify link strategy for external vs. internal documentation.The document references external Ballerina documentation (lines 124, 129) with direct links to
ballerina.ioresources. Based on past review feedback, confirm whether these should instead point to internal BI documentation or reference a BI-specific data mapping overview page. This affects user consistency and reduces dependency on external resources.Also applies to: 124-124, 129-129
en/docs/developer-guides/data-mapping/manual-data-mapping.md (1)
1-1: Asset paths and cross-references properly updated for documentation restructuring.All asset paths have been consistently updated from
data-mapping/tomanual-data-mapping/, and the new "AI Data Mapping" section with its cross-reference to the AI Data Mapping guide is well-placed within the workflow. The naming reflects the document's focus on manual mapping techniques.Also applies to: 13-14, 22-23, 80-81, 112-113, 122-124, 134-142
en/mkdocs.yml (1)
112-114: Navigation structure properly reorganized for dual data mapping documentation.The transition from a single Data Mapping entry to a nested structure with Manual Data Mapping and AI Data Mapping sub-pages correctly reflects the documentation split. YAML formatting and file paths are accurate.
VellummyilumVinoth
force-pushed
the
datamapper-doc
branch
from
f9a6624 to
86ce7d9
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @en/docs/developer-guides/data-mapping/ai-data-mapping.md:
- Around line 110-120: In the "### 6. Code validation" section remove the stray
blank line between the list items so the "- Reserved keyword handling" line is
part of the same hyphen list; ensure each bullet uses the same "- " prefix and
no extra blank lines so the list renders continuously under "Code validation".
In @en/mkdocs.yml:
- Around line 114-116: The "Data Mapping" nav block is missing YAML list markers
for its nested items; update the "Data Mapping:" entry so the nested pages
"Manual Data Mapping" and "AI Data Mapping" are prefixed with '-' like the other
sections (i.e., treat "Data Mapping" as a parent and add '-' before "Manual Data
Mapping: developer-guides/data-mapping/manual-data-mapping.md" and '-' before
"AI Data Mapping: developer-guides/data-mapping/ai-data-mapping.md" so they
become proper YAML list items).
🧹 Nitpick comments (1)
en/docs/developer-guides/data-mapping/manual-data-mapping.md (1)
134-142: Consider capitalizing section heading for consistency.The heading "AI data mapping" uses lowercase "data mapping" while other H3 headings in this file use title case (e.g., "Create simple mapping", "Many-to-one mapping"). Consider using "AI Data Mapping" for consistency.
📝 Suggested fix
-### AI data mapping +### AI Data Mapping
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (19)
en/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/ai-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/claim-submission-to-international401-claim.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/hl7v23-pid-to-international401-patient.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/ai-data-mapping/manual-data-mapper-visualizer.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-inline-data-mapper.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/add-return.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/array-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/auto-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-integration.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-new-type.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/create-service.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/edit-resource.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/inline-data-mapper-added.pngis excluded by!**/*.pngen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/many-to-one-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/simple-mapping.gifis excluded by!**/*.gifen/docs/assets/img/developer-guides/data-mapping/manual-data-mapping/type-from-json.gifis excluded by!**/*.gif
📒 Files selected for processing (5)
en/docs/developer-guides/data-mapping/ai-data-mapping.mden/docs/developer-guides/data-mapping/manual-data-mapping.mden/docs/index.mden/docs/integration-guides/usecases/datamapper/overview.mden/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (2)
- en/docs/index.md
- en/docs/integration-guides/usecases/datamapper/overview.md
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-11-12T05:34:18.459Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/os-level-security.md:1-25
Timestamp: 2025-11-12T05:34:18.459Z
Learning: In the WSO2 docs-bi repository, specifically in deployment best practices documentation files under en/docs/deploy/deployment-best-practices/, using h3 (###) headings directly after h1 titles (instead of h2) is intentional and should not be flagged.
Applied to files:
en/docs/developer-guides/data-mapping/ai-data-mapping.md
📚 Learning: 2025-11-12T05:34:19.589Z
Learnt from: dulajdilshan
Repo: wso2/docs-bi PR: 169
File: en/docs/deploy/deployment-best-practices/network-level-security.md:1-20
Timestamp: 2025-11-12T05:34:19.589Z
Learning: In the wso2/docs-bi repository documentation files, using h3 (###) subsection headings directly under h1 (#) titles is an intentional style choice, even though it violates standard markdown heading increment rules.
Applied to files:
en/docs/developer-guides/data-mapping/ai-data-mapping.md
🪛 LanguageTool
en/docs/developer-guides/data-mapping/manual-data-mapping.md
[style] ~140-~140: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 5621 characters long)
Context: ...f" alt="Auto Mapping" width="70%"> !!! info "AI Data Mapper" To learn more...
(EN_EXCESSIVE_EXCLAMATION)
en/docs/developer-guides/data-mapping/ai-data-mapping.md
[style] ~112-~112: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...idated by the Ballerina Language Server prior to output, ensuring: - Syntactic correctn...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[grammar] ~129-~129: Use a hyphen to join words.
Context: ...idth="70%"> ### Example 2: Standard to standard format ([hl7v23:PID](https:/...
(QB_NEW_EN_HYPHEN)
[grammar] ~129-~129: Use a hyphen to join words.
Context: ...h="70%"> ### Example 2: Standard to standard format ([hl7v23:PID](https://ce...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (2)
en/docs/developer-guides/data-mapping/ai-data-mapping.md (1)
1-153: Well-structured documentation for the AI Data Mapper feature.The documentation is comprehensive, covering the concept, workflow, features, healthcare examples, and responsible use guidance. The content aligns well with the PR objectives of creating user-facing documentation for the AI Data Mapper.
A few optional suggestions:
- Line 112: Consider using "before" instead of "prior to" for conciseness (per static analysis hint).
- Line 129: The heading "Standard to standard format" could optionally be hyphenated as "Standard-to-standard format" for consistency.
en/docs/developer-guides/data-mapping/manual-data-mapping.md (1)
1-170: Documentation updates look good.The renaming to "Manual Data Mapping" and path updates are consistent throughout the file. The cross-reference to the new AI Data Mapping guide at line 142 provides good navigation between the two related documentation pages.
| ### 6. Code validation | ||
|
|
||
| All generated mappings are validated by the Ballerina Language Server prior to output, ensuring: | ||
|
|
||
| - Syntactic correctness | ||
| - Type safety compliance | ||
| - Proper import statements | ||
|
|
||
| - Reserved keyword handling | ||
|
|
||
| The output is guaranteed to be compilable code. |
There was a problem hiding this comment.
Fix the list formatting issue in the code validation section.
There's a blank line between list items at lines 117-118 which breaks the Markdown list continuity. The "Reserved keyword handling" item appears disconnected from the rest of the list.
📝 Suggested fix
All generated mappings are validated by the Ballerina Language Server prior to output, ensuring:
- Syntactic correctness
- Type safety compliance
- Proper import statements
-
- Reserved keyword handling
The output is guaranteed to be compilable code.📝 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.
| ### 6. Code validation | |
| All generated mappings are validated by the Ballerina Language Server prior to output, ensuring: | |
| - Syntactic correctness | |
| - Type safety compliance | |
| - Proper import statements | |
| - Reserved keyword handling | |
| The output is guaranteed to be compilable code. | |
| ### 6. Code validation | |
| All generated mappings are validated by the Ballerina Language Server prior to output, ensuring: | |
| - Syntactic correctness | |
| - Type safety compliance | |
| - Proper import statements | |
| - Reserved keyword handling | |
| The output is guaranteed to be compilable code. |
🧰 Tools
🪛 LanguageTool
[style] ~112-~112: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...idated by the Ballerina Language Server prior to output, ensuring: - Syntactic correctn...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🤖 Prompt for AI Agents
In @en/docs/developer-guides/data-mapping/ai-data-mapping.md around lines 110 -
120, In the "### 6. Code validation" section remove the stray blank line between
the list items so the "- Reserved keyword handling" line is part of the same
hyphen list; ensure each bullet uses the same "- " prefix and no extra blank
lines so the list renders continuously under "Code validation".
| - Data Mapping: | ||
| Manual Data Mapping: developer-guides/data-mapping/manual-data-mapping.md | ||
| AI Data Mapping: developer-guides/data-mapping/ai-data-mapping.md |
There was a problem hiding this comment.
YAML syntax issue: missing list markers for nested navigation items.
The nested navigation items under "Data Mapping" are missing the - list markers. Comparing to other nested sections in this file (e.g., "Debugging & Troubleshooting" at lines 119-124), each sub-item should be prefixed with -.
🐛 Proposed fix
- Data Mapping:
- Manual Data Mapping: developer-guides/data-mapping/manual-data-mapping.md
- AI Data Mapping: developer-guides/data-mapping/ai-data-mapping.md
+ - Manual Data Mapping: developer-guides/data-mapping/manual-data-mapping.md
+ - AI Data Mapping: developer-guides/data-mapping/ai-data-mapping.md📝 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.
| - Data Mapping: | |
| Manual Data Mapping: developer-guides/data-mapping/manual-data-mapping.md | |
| AI Data Mapping: developer-guides/data-mapping/ai-data-mapping.md | |
| - Data Mapping: | |
| - Manual Data Mapping: developer-guides/data-mapping/manual-data-mapping.md | |
| - AI Data Mapping: developer-guides/data-mapping/ai-data-mapping.md |
🤖 Prompt for AI Agents
In @en/mkdocs.yml around lines 114 - 116, The "Data Mapping" nav block is
missing YAML list markers for its nested items; update the "Data Mapping:" entry
so the nested pages "Manual Data Mapping" and "AI Data Mapping" are prefixed
with '-' like the other sections (i.e., treat "Data Mapping" as a parent and add
'-' before "Manual Data Mapping:
developer-guides/data-mapping/manual-data-mapping.md" and '-' before "AI Data
Mapping: developer-guides/data-mapping/ai-data-mapping.md" so they become proper
YAML list items).
2 participants
Description
This PR adds comprehensive documentation for AI Data Mapper user guide.
Resolves: wso2/product-ballerina-integrator#1883
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.