Conversation
…ration guide Co-authored-by: EngincanV <[email protected]>
There was a problem hiding this comment.
Pull request overview
Updates the ABP 10.2 migration guide to include an additional required step for ABP Commercial (Pro) users who use the AI Management Module’s MVC UI, ensuring client-side assets are installed correctly for the chat playground’s enhanced markdown rendering.
Changes:
- Updated the Pro section introduction to support multiple conditional migration steps.
- Added a new Pro subsection instructing MVC UI users to add
@volo/ai-managementtopackage.jsonand runabp install-libs.
| ### Add `@volo/ai-management` NPM Package for MVC UI | ||
|
|
||
| If you are using the MVC UI of the [AI Management Module](../../modules/ai-management.md), you need to add the `@volo/ai-management` package to your `package.json` file. This package was introduced in ABP v10.2 to support the enhanced markdown rendering on the chat playground. |
There was a problem hiding this comment.
For consistency with the module documentation wording (“MVC / Razor Pages UI”), consider using the same phrasing in this heading (and/or the paragraph below) so users can more easily map this step to the relevant UI option.
| ### Add `@volo/ai-management` NPM Package for MVC UI | |
| If you are using the MVC UI of the [AI Management Module](../../modules/ai-management.md), you need to add the `@volo/ai-management` package to your `package.json` file. This package was introduced in ABP v10.2 to support the enhanced markdown rendering on the chat playground. | |
| ### Add `@volo/ai-management` NPM Package for MVC / Razor Pages UI | |
| If you are using the MVC / Razor Pages UI of the [AI Management Module](../../modules/ai-management.md), you need to add the `@volo/ai-management` package to your `package.json` file. This package was introduced in ABP v10.2 to support the enhanced markdown rendering on the chat playground. |
|
|
||
| ### Add `@volo/ai-management` NPM Package for MVC UI | ||
|
|
||
| If you are using the MVC UI of the [AI Management Module](../../modules/ai-management.md), you need to add the `@volo/ai-management` package to your `package.json` file. This package was introduced in ABP v10.2 to support the enhanced markdown rendering on the chat playground. |
There was a problem hiding this comment.
The relative link to the AI Management Module docs appears to be incorrect. This repo has the AI Management docs at docs/en/modules/ai-management/index.md (and other docs, e.g. the ABP 10.1 migration guide, link to ../../modules/ai-management/index.md). Update the link target so it resolves correctly.
| If you are using the MVC UI of the [AI Management Module](../../modules/ai-management.md), you need to add the `@volo/ai-management` package to your `package.json` file. This package was introduced in ABP v10.2 to support the enhanced markdown rendering on the chat playground. | |
| If you are using the MVC UI of the [AI Management Module](../../modules/ai-management/index.md), you need to add the `@volo/ai-management` package to your `package.json` file. This package was introduced in ABP v10.2 to support the enhanced markdown rendering on the chat playground. |
|
|
||
| Add the following line to the `dependencies` section of your `package.json` file: | ||
|
|
||
| ```json |
There was a problem hiding this comment.
The fenced block is labeled as json, but the snippet shown ("@volo/ai-management": "10.2.0") isn’t valid JSON on its own. Consider showing it within the dependencies object (or switching the fence to text) to avoid copy/paste confusion.
| ```json | |
| ```text |
| ## Pro | ||
|
|
||
| There are no breaking changes on the PRO side. However, if you use the Identity Pro module with Entity Framework Core, you need to make the following update: | ||
| There are no breaking changes on the PRO side. However, please check the following sections if they apply to your application. |
There was a problem hiding this comment.
The intro sentence says “There are no breaking changes on the PRO side” but the sections below describe required updates for some PRO module users. Consider rephrasing to clarify that there are no unconditional breaking changes, but there are conditional actions depending on which PRO modules/UIs you use.
| There are no breaking changes on the PRO side. However, please check the following sections if they apply to your application. | |
| There are no unconditional breaking changes on the PRO side, but some module/UI-specific updates may be required. Please review the following sections and apply them if they apply to your application. |
Description
The ABP 10.2 migration guide was missing a required step for MVC UI users of the AI Management Module: adding the new
@volo/ai-managementNPM package introduced for enhanced markdown rendering on the chat playground.Changes to
docs/en/release-info/migration-guides/abp-10-2.md:@volo/ai-managementNPM Package for MVC UI" — instructs developers to add the package topackage.jsonand runabp install-libsDevelopers using MVC UI of the AI Management Module must add to their
package.json:Then run:
Checklist
How to test it?
Verify the rendered migration guide at
docs/en/release-info/migration-guides/abp-10-2.mdincludes the new@volo/ai-managementsection under Pro.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.