diff --git a/docs/CONVENTIONS.md b/docs/CONVENTIONS.md new file mode 100644 index 00000000..fd65f27b --- /dev/null +++ b/docs/CONVENTIONS.md @@ -0,0 +1,8 @@ +# Conventions + +> For core framework conventions see `AyCode.Core/docs/CONVENTIONS.md`. +> For Mango.Nop library conventions see `Mango.Nop Libraries/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.