Docs/revamp #565
Merged
Docs/revamp #565
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR substantially improves the documentation architecture for the Kentico Migration Tool repository, providing clear guidance for both users and contributors through comprehensive README files, visual diagrams, and better organization.
Key Changes:
- Added visual architecture diagrams (project dependencies and migration flow) with source files
- Created comprehensive Repository Structure guide explaining all projects and their relationships
- Added audience-specific README files for every project (15 new READMEs)
- Restructured main README.md with clearer user journey and quick-start guidance
- Significantly expanded Migration.Tool.Extensions/README.md with detailed implementation guides
Reviewed changes
Copilot reviewed 23 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
images/diagrams/project-dependencies.png |
Visual diagram showing project organization and dependency relationships |
images/diagrams/project-dependencies.drawio |
Editable source file for project dependencies diagram |
images/diagrams/migration-flow.drawio |
Editable source file for migration flow diagram |
docs/Repository-Structure.md |
New comprehensive guide to repository organization and component relationships |
docs/Usage-Guide.md |
Added link to upgrade walkthrough |
docs/Supported-Data.md |
Added links to planning guides |
docs/Contributing-Setup.md |
Removed outdated "migration protocol" reference |
README.md |
Major restructure with clearer user journey, quick-start guide, and better organization |
Migration.Tool.Tests/README.md |
New contributor-focused README for test project |
Migration.Tool.KXP.Extensions/README.MD |
Added audience clarification |
Migration.Tool.KXP.Api/README.md |
New contributor-focused README for API wrapper project |
Migration.Tool.KX13/README.md |
New contributor-focused README for KX13 database models |
Migration.Tool.KX12/README.md |
New contributor-focused README for KX12 database models |
Migration.Tool.K11/README.md |
New contributor-focused README for K11 database models |
Migration.Tool.Extensions/README.md |
Massively expanded with detailed implementation guides and architecture explanations |
Migration.Tool.Core.KX13/README.md |
New contributor-focused README for KX13 handlers |
Migration.Tool.Core.KX12/README.md |
New contributor-focused README for KX12 handlers |
Migration.Tool.Core.K11/README.md |
New contributor-focused README for K11 handlers |
Migration.Tool.Common/README.md |
New contributor-focused README for shared infrastructure |
Migration.Tool.CLI/README.md |
Added audience clarification and walkthrough links |
KX13.NET48.Extensions/README.md |
New README for .NET Framework 4.8 API controllers |
KX13.Extensions/README.md |
New README for ASP.NET Core API controllers |
KVA/Migration.Tool.Source/README.md |
New contributor-focused README for abstraction layer |
.github/ISSUE_TEMPLATE/bug_report.md |
Removed outdated "migration protocol" reference |
No issues found. This is a well-executed documentation improvement that significantly enhances repository discoverability and usability. The changes are clear, consistent, and provide appropriate context for different audiences (users vs. contributors).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…l and add a deprecation notice about media libraries.
dominikag2
commented
Jan 7, 2026
skurekjakub
reviewed
Jan 8, 2026
skurekjakub
reviewed
Jan 8, 2026
skurekjakub
reviewed
Jan 8, 2026
seangwright
reviewed
Jan 8, 2026
…ings that can be referenced and are more scannable (less noise without the bullets). The second level bullets describing each data type support remain.
- Supported data - update headings - update version matrix
…/WARNING/...] format)
JakubS-Kentico
previously approved these changes
Jan 14, 2026
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.
Motivation
KMT GitHub repository lacks a clear architecture overview and consistent project documentation, making it difficult for both developers and AI assistants to understand the tool's structure and components. The main goals: