From 1b11ca257957c661a590f833de67711032c4499c Mon Sep 17 00:00:00 2001
From: Loretta <jozsef.b@aycode.com>
Date: Sat, 23 May 2026 09:27:34 +0200
Subject: [PATCH] Add XML doc conventions and update references

Added a section on XML documentation standards to CONVENTIONS.md, clarified references to core and Mango.Nop framework convention docs, and improved formatting. Enabled EmitCompilerGeneratedFiles in Mango.Nop.Core.csproj.
---
 Mango.Nop.Core/Mango.Nop.Core.csproj | 1 +
 Mango.Nop.Core/docs/CONVENTIONS.md   | 4 ++++
 docs/CONVENTIONS.md                  | 4 ++++
 3 files changed, 9 insertions(+)

diff --git a/Mango.Nop.Core/Mango.Nop.Core.csproj b/Mango.Nop.Core/Mango.Nop.Core.csproj
index d4e6715..f4a2b1f 100644
--- a/Mango.Nop.Core/Mango.Nop.Core.csproj
+++ b/Mango.Nop.Core/Mango.Nop.Core.csproj
@@ -6,6 +6,7 @@
 		<Nullable>enable</Nullable>
 		<BaseOutputPath>bin\FruitBank</BaseOutputPath>
 		<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
+		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
 		<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
 		<CopyRefAssembliesToPublishDirectory>true</CopyRefAssembliesToPublishDirectory>
 	</PropertyGroup>
diff --git a/Mango.Nop.Core/docs/CONVENTIONS.md b/Mango.Nop.Core/docs/CONVENTIONS.md
index 39ab8f8..886c5e0 100644
--- a/Mango.Nop.Core/docs/CONVENTIONS.md
+++ b/Mango.Nop.Core/docs/CONVENTIONS.md
@@ -18,6 +18,10 @@ Follow the doctrine in AyCode.Core's `docs/CONVENTIONS.md#framework-first-placem
 - **`IMg` prefix**: for Mango-framework-level interfaces (e.g. `IMgModelDtoBase`, `IMgSoftRemoveEntity`)
 - **No prefix**: for NopCommerce entity mirrors in `NopDependencies/` — they stay in Nop namespace, same name as upstream
 
+## XML Documentation
+
+`<summary>` — brief, developer-facing, readable in VS IntelliSense tooltip. NO implementation details, NO wire-format / byte-level / perf specifics — those live in `docs/TOPIC/*.md`. Add `<example>` only when usage is non-obvious; otherwise omit.
+
 ## See Also
 
 - Core framework naming (`Ac` / `IAc` prefixes), patterns, serialization conventions: AyCode.Core's `docs/CONVENTIONS.md`
diff --git a/docs/CONVENTIONS.md b/docs/CONVENTIONS.md
index 5b6b8fb..9b60b17 100644
--- a/docs/CONVENTIONS.md
+++ b/docs/CONVENTIONS.md
@@ -9,6 +9,10 @@
 - **`Base` suffix** for abstract base classes: `MgEntityBase`, `ModelDtoBase`, `MgBackgroundServiceBase`.
 - **`Nop` prefix** for nopCommerce bridge types: `NopLogWriter`, `NopLoggerMsSqlNopDataProvider`, `NopCommonConst`.
 
+## XML Documentation
+
+`<summary>` — brief, developer-facing, readable in VS IntelliSense tooltip. NO implementation details, NO wire-format / byte-level / perf specifics — those live in `docs/TOPIC/*.md`. Add `<example>` only when usage is non-obvious; otherwise omit.
+
 ## Patterns
 
 ### DTO Bidirectional Mapping