Skip to content

Conversation

@alistairmatthews
Copy link
Contributor

The existing MySQL Pomelo EF integration document is comprehensive but difficult for beginners. This PR is intended to keep the comprehensive information but make it easier for those who want to get going quickly. I've used Copilot to propagate changes from the new PostgreSQL documents to the MySQL EF ones.

This PR:

  • Splits the large integration doc into two: Hosting and Client.
  • Adds a getting started short tutorial.
  • Adds a Properties of the MySQL resources section to the client reference docs. This describes what configuration values are injected by the WithReference() method.

@alistairmatthews alistairmatthews marked this pull request as ready for review January 15, 2026 15:10
Copilot AI review requested due to automatic review settings January 15, 2026 15:10
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request restructures the MySQL documentation by splitting a single comprehensive document into three separate documents: a getting started guide, a hosting integration reference, and a client integration reference. However, there is a critical mismatch between the document titles and content.

Changes:

  • Split the monolithic MySQL documentation into three separate files (get-started, host, and client)
  • Updated navigation routing in integration-docs.json, overview.mdx, and sidebar configuration
  • Added a "Properties of the MySQL resources" section to the client reference

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
integration-docs.json Updated href for Aspire.Pomelo.EntityFrameworkCore.MySql package to point to new getting started guide
overview.mdx Updated MySQL card link to point to new getting started page
mysql-host.mdx New hosting integration reference document covering MySQL server/database resources
mysql-get-started.mdx New getting started guide with multi-language examples (C#, Python, JavaScript)
mysql-client.mdx New client integration reference with properties documentation and configuration options
mysql.mdx Deleted original monolithic document
integrations.topics.ts Updated sidebar to show MySQL Pomelo as expandable section with three sub-pages

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,297 @@
---
title: Get started with the MySQL Pomelo Entity Framework Core integrations
Copy link

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document title references 'MySQL Pomelo Entity Framework Core integrations' but the content only covers Aspire.MySqlConnector and Aspire.Hosting.MySql packages, not the Aspire.Pomelo.EntityFrameworkCore.MySql package. Entity Framework Core integrations use DbContext and methods like AddDbContext, which are not present in this documentation. Either the title should be changed to remove 'Entity Framework Core' or the content should be updated to cover the actual EF Core integration package.

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,257 @@
---
title: MySQL Pomelo Entity Framework Core Hosting integration reference
Copy link

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document title references 'MySQL Pomelo Entity Framework Core' but the hosting integration (Aspire.Hosting.MySql) is not specific to Entity Framework Core. The hosting integration can be used with any MySQL client, not just EF Core. The title should either remove 'Entity Framework Core' or clarify that this hosting integration supports multiple client types including EF Core.

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,239 @@
---
title: MySQL Pomelo Entity Framework Core Client integration reference
Copy link

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document title references 'MySQL Pomelo Entity Framework Core Client integration' but the content documents Aspire.MySqlConnector (which provides MySqlDataSource), not Aspire.Pomelo.EntityFrameworkCore.MySql (which would provide DbContext registration). Entity Framework Core integrations use DbContext and methods like AddDbContext. The title should be changed to accurately reflect that this documents the MySqlConnector client integration, not the EF Core integration.

Copilot uses AI. Check for mistakes.
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.

1 participant