Update and improve Data Mapper documentation#480
Merged
Conversation
…ing terminology and enhancing descriptions
…improving descriptions in array mapping sections
KCSAbeywickrama
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
KCSAbeywickrama
requested review from
Copilot and
pasindufernando1
and removed request for
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (10)
✅ Files skipped from review due to trivial changes (7)
📝 WalkthroughWalkthroughDocumentation-only updates to Data Mapper pages: standardized "Sub Mappings" wording, clarified array mapping clause labels and nested/join instructions, narrowed inline entry points to Declare Variable, and aligned mapping/editor wording (expression bar/editor, selection workflows, "Map using" headings). ChangesData Mapper Feature Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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: 3
🧹 Nitpick comments (1)
en/docs/develop/integration-artifacts/supporting/data-mapper/submappings.md (1)
2-2: 💤 Low valueConsider renaming file to match the updated title.
The title was updated to "Sub Mappings" (two words), but the filename remains
submappings.md. Per coding guidelines, spaces in titles should convert to hyphens in URLs, suggesting the file should besub-mappings.mdfor consistency. However, if the existing filename is intentionally preserved for backward compatibility with existing links, this is acceptable.Also applies to: 6-6
🤖 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/submappings.md` at line 2, The document header uses the title "Sub Mappings" but the filename is submappings.md; rename the file to sub-mappings.md to match the title-to-URL convention (spaces → hyphens) and keep URLs/links consistent, or if backward-compatibility is required, add a redirect/alias from submappings.md to sub-mappings.md; update any references to the file name accordingly and verify the title line ("title: Sub Mappings") remains unchanged.
🤖 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/understand-ide/editors/datamapper-editor.md`:
- Line 74: The H2 header "Auto Map" should use sentence case per guidelines;
update the H2 text from "Auto Map" to "Auto map" (locate the header string "Auto
Map" in the datamapper-editor.md content and change only the capitalization).
- Line 48: Update the H3 header "Global Inputs" to sentence case by changing it
to "Global inputs" so it conforms to the project's header casing guideline;
locate the H3 line in datamapper-editor.md (the header text "Global Inputs") and
replace it with "Global inputs".
- Line 52: Update the H3 header text "Sub Mappings" to sentence case by changing
it to "Sub mappings" wherever the H3 appears (the header string "Sub Mappings"
in the datamapper-editor.md H3); ensure only the first word is capitalized and
proper nouns remain capitalized to comply with the sentence case guideline for
non-H1 headers.
---
Nitpick comments:
In `@en/docs/develop/integration-artifacts/supporting/data-mapper/submappings.md`:
- Line 2: The document header uses the title "Sub Mappings" but the filename is
submappings.md; rename the file to sub-mappings.md to match the title-to-URL
convention (spaces → hyphens) and keep URLs/links consistent, or if
backward-compatibility is required, add a redirect/alias from submappings.md to
sub-mappings.md; update any references to the file name accordingly and verify
the title line ("title: Sub Mappings") remains unchanged.
🪄 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: 93a5766c-13df-490f-b3db-049638babbad
📒 Files selected for processing (8)
en/docs/develop/integration-artifacts/supporting/data-mapper/array-mappings/array-to-array.mden/docs/develop/integration-artifacts/supporting/data-mapper/array-mappings/array-to-single-value.mden/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.mden/docs/develop/integration-artifacts/supporting/data-mapper/generic-type-mappings.mden/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.mden/docs/develop/integration-artifacts/supporting/data-mapper/submappings.mden/docs/develop/understand-ide/editors/datamapper-editor.mden/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Data Mapper documentation for clearer terminology, UI flow descriptions, and current editor behavior across the Data Mapper guide and related editor pages.
Changes:
- Refreshes Data Mapper Editor descriptions, header controls, expression bar, input/output sides, and mapping area behavior.
- Updates Data Mapper capability pages for expression bar, generic sample generation, array mapping actions, and sub mapping terminology.
- Adjusts cross-links and wording from related Flow Diagram editor documentation.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md |
Updates the Data Mapper reference link wording from the Statement page. |
en/docs/develop/understand-ide/editors/datamapper-editor.md |
Revises Data Mapper Editor overview, open paths, controls, expression bar, sides, and mapping area. |
en/docs/develop/integration-artifacts/supporting/data-mapper/submappings.md |
Renames and rewords the Submappings page terminology. |
en/docs/develop/integration-artifacts/supporting/data-mapper/mapping-capabilities.md |
Updates mapping interaction wording, expression bar details, and custom/transformation function labels. |
en/docs/develop/integration-artifacts/supporting/data-mapper/generic-type-mappings.md |
Updates generic JSON/XML sample generation instructions. |
en/docs/develop/integration-artifacts/supporting/data-mapper/data-mapper.md |
Updates overview wording, prerequisites, and capability naming. |
en/docs/develop/integration-artifacts/supporting/data-mapper/array-mappings/array-to-single-value.md |
Refines array-to-single-value mapping option descriptions. |
en/docs/develop/integration-artifacts/supporting/data-mapper/array-mappings/array-to-array.md |
Updates array mapping clause labels and nested/join flow wording. |
…rences to Update Variable nodes
…Mappings" across multiple documentation files
…ransformation function description
…expression bar description
pasindufernando1
approved these changes
May 19, 2026
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.
Purpose
Please review and merge #474 first, since this PR is built on top of it.
Summary by CodeRabbit