From 6c60d7b4039206be94d7cd2d80dc36dd2a17cb5a Mon Sep 17 00:00:00 2001 From: Loretta Date: Sat, 23 May 2026 09:27:35 +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. --- Nop.Plugin.Misc.AIPlugin/docs/CONVENTIONS.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 Nop.Plugin.Misc.AIPlugin/docs/CONVENTIONS.md diff --git a/Nop.Plugin.Misc.AIPlugin/docs/CONVENTIONS.md b/Nop.Plugin.Misc.AIPlugin/docs/CONVENTIONS.md new file mode 100644 index 0000000..d080cfa --- /dev/null +++ b/Nop.Plugin.Misc.AIPlugin/docs/CONVENTIONS.md @@ -0,0 +1,8 @@ +# Conventions + +> For core framework conventions see `AyCode.Core/docs/CONVENTIONS.md`. +> For Mango.Nop framework conventions see `Mango.Nop.Core/docs/CONVENTIONS.md`. + +## XML Documentation + +`` — 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 `` only when usage is non-obvious; otherwise omit.