Skip to content

chore: Rework existing docs to incorporate it to the new structure#221

Merged
lordrip merged 1 commit into
KaotoIO:mainfrom
lordrip:chore/rework-existing-docs
Apr 2, 2026
Merged

chore: Rework existing docs to incorporate it to the new structure#221
lordrip merged 1 commit into
KaotoIO:mainfrom
lordrip:chore/rework-existing-docs

Conversation

@lordrip

@lordrip lordrip commented Apr 2, 2026

Copy link
Copy Markdown
Member
image

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation structure with streamlined navigation and updated menu items
    • Significantly expanded DataMapper documentation with comprehensive guides covering overview, schema support, parameter mapping, conditional mapping workflows, and XPath editor usage
    • Consolidated and enhanced Designer documentation with improved node management sections and runtime selector guidance
    • Updated documentation hierarchy for better content accessibility and organization

@coderabbitai

coderabbitai Bot commented Apr 2, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2ac901d3-bf20-4fc4-84f2-14845bbf67ba

📥 Commits

Reviewing files that changed from the base of the PR and between b9f8934 and 39765d4.

⛔ Files ignored due to path filters (85)
  • content/docs/datamapper/catalog-datamapper-tile.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-add-conditional-mapping.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-add-more-mapping.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-add-parameter-confirm.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-add-parameter.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-add-selector.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-attach-schema-attach.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-attach-schema-file-btn.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-attach-schema.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-blank.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-choose-add-when.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-choose-choose.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-choose-otherwise-mapping.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-choose-when-added.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-choose-when-condition.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-choose-when-mapping.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-collection-field.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-configure-button.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-delete-mapping-btn.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-delete-mapping-confirm.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-delete-param-confirm.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-delete-param-trash.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-detach-button.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-detach-confirm.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-done.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-drag-name.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-drop-name.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-for-each-condition.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-for-each-for-each.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-for-each-mappings.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-if-3dots.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-if-condition.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-if-if.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-if-mapping.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-array-field.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-attach-schema-attach.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-field-label-accountid.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-field-label-object.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-mappings-all.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-schema-attached.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-json-select-schema.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-map-2nd-for-each-children.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-map-2nd-for-each.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-schema-attached.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-select-root-element.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-select-schema.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-source-target.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-type-xpath.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-wrap-with-for-each.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-close.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-dnd-fields.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-done.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-editor.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-functions-dnd.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-functions.png is excluded by !**/*.png
  • content/docs/datamapper/datamapper-xpath-pencil.png is excluded by !**/*.png
  • content/docs/datamapper/dm_chooserootelement.mp4 is excluded by !**/*.mp4
  • content/docs/datamapper/dm_json.mp4 is excluded by !**/*.mp4
  • content/docs/datamapper/dm_multiplemappings.mp4 is excluded by !**/*.mp4
  • content/docs/datamapper/kaoto-datamapper-step.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/catalog-setbody.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/catalog.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/delete-button.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/delete-route.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/disable-button.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/disabled-step.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/generate-docs-button.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/generate-documentation.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/no-route.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/replace-button.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/setbody-expression.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/setbody-step.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/step-actions.png is excluded by !**/*.png
  • content/docs/designer/02-working-with-nodes/ui-overview.png is excluded by !**/*.png
  • content/docs/designer/04-runtime-selector/runtime-selector.png is excluded by !**/*.png
  • content/docs/designer/04-runtime-selector/setting-kaoto-catalog-url.png is excluded by !**/*.png
  • content/docs/designer/04-runtime-selector/vscode-kaoto-settings.png is excluded by !**/*.png
  • content/docs/manual/01_installation/kaoto-install.png is excluded by !**/*.png
  • content/docs/manual/02_gettingstarted/create-integration.mp4 is excluded by !**/*.mp4
  • content/docs/manual/02_gettingstarted/empty-vscode.png is excluded by !**/*.png
  • content/docs/manual/02_gettingstarted/launch-button.png is excluded by !**/*.png
  • content/docs/manual/02_gettingstarted/launch-integration.mp4 is excluded by !**/*.mp4
  • content/docs/manual/02_gettingstarted/launch-terminal.png is excluded by !**/*.png
  • content/docs/manual/02_gettingstarted/new-route.png is excluded by !**/*.png
  • content/docs/manual/02_gettingstarted/show-source.mp4 is excluded by !**/*.mp4
📒 Files selected for processing (16)
  • content/docs/_index.md
  • content/docs/datamapper/_index.md
  • content/docs/datamapper/dm_chooserootelement.vtt
  • content/docs/datamapper/dm_json.vtt
  • content/docs/datamapper/dm_multiplemappings.vtt
  • content/docs/designer/01-managing-integrations/_index.md
  • content/docs/designer/02-nodes/_index.md
  • content/docs/designer/02-working-with-nodes/_index.md
  • content/docs/designer/03-reordering-nodes/_index.md
  • content/docs/designer/04-runtime-selector/_index.md
  • content/docs/designer/_index.md
  • content/docs/manual/01_installation/index.md
  • content/docs/manual/02_gettingstarted/index.md
  • content/docs/manual/04_datamapper/index.md
  • content/docs/manual/09_generatingcatalog/index.md
  • content/docs/manual/_index.md
💤 Files with no reviewable changes (6)
  • content/docs/manual/09_generatingcatalog/index.md
  • content/docs/manual/04_datamapper/index.md
  • content/docs/designer/02-nodes/_index.md
  • content/docs/manual/01_installation/index.md
  • content/docs/manual/_index.md
  • content/docs/manual/02_gettingstarted/index.md

📝 Walkthrough

Walkthrough

This PR restructures the documentation hierarchy by removing the old "User Manual" section and reorganizing content under the "Designer" section. The homepage gains expanded introductory content, DataMapper documentation is upgraded from draft to comprehensive, and designer sub-pages are consolidated with updated navigation links.

Changes

Cohort / File(s) Summary
Homepage & Navigation
content/docs/_index.md
Adds expanded introductory content (audience, Kaoto description, catalog defaults, benefits list) and updates sidebar navigation to remove "User Manual" link and add "DataMapper" section link.
Designer Section Restructure
content/docs/designer/_index.md, 01-managing-integrations/_index.md, 03-reordering-nodes/_index.md
Updates navigation links, uncomments sections, and fixes link targets (e.g., ../02-nodes../02-working-with-nodes).
Designer Pages Reorganization
content/docs/designer/02-nodes/_index.md, 02-working-with-nodes/_index.md, 04-runtime-selector/_index.md
Consolidates and replaces node documentation: deletes 02-nodes, restructures 02-working-with-nodes with condensed operational guidance and figure shortcodes, and expands 04-runtime-selector with comprehensive catalog generator CLI instructions and VSCode configuration steps.
DataMapper Documentation
content/docs/datamapper/_index.md
Replaces draft content with full documentation covering overview, capabilities, usage workflows (adding steps, schema attachment, field mapping, conditional mappings), XPath editor, and parameter management; removes draft flag.
Old Manual Section Deletion
content/docs/manual/_index.md, 01_installation/index.md, 02_gettingstarted/index.md, 04_datamapper/index.md, 09_generatingcatalog/index.md
Removes entire old manual structure including installation, getting started, DataMapper (relocated to designer section), and catalog generation guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • PVinaches

Poem

🐰 Hops of documentation, so neat and aligned,
Old manuals shuffle, new DataMapper shines!
Designer paths clearer, with Nodes reorganized,
Catalogs and Runtimes, now unified!
A restructured warren where knowledge can thrive! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: reorganizing existing documentation into a new structure, which aligns with the file movements (docs/manual → docs/datamapper and docs/designer subsections) and content consolidation visible throughout the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

@lordrip lordrip merged commit f2e7970 into KaotoIO:main Apr 2, 2026
2 checks passed
@lordrip lordrip deleted the chore/rework-existing-docs branch April 2, 2026 14:44
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.

2 participants