From b062c4c7129b6f5fb4de0c6012299e507667a821 Mon Sep 17 00:00:00 2001 From: Loretta Date: Mon, 30 Mar 2026 08:54:33 +0200 Subject: [PATCH] Add structured metadata and update doc references - Introduce @repo and @project metadata blocks in copilot-instructions.md and README.md for all projects, declaring type, dependencies, and layer. - Update all documentation links to reference canonical AyCode.Core and AyCode.Blazor repo locations, removing hardcoded paths. - Move MgGridBase and related doc references to AyCode.Blazor.Components/docs/ to reflect repo reorg. - Expand project READMEs with purpose, key files, and dependency tables for clearer architecture. - Update glossary, conventions, and architecture docs to match new doc structure and reference locations. - Apply minor corrections to terminology and file references for consistency and accuracy. - Standardize documentation and make project relationships explicit. --- .github/copilot-instructions.md | 6 ++++++ AyCode.Blazor.Components.Tests/README.md | 4 ++++ AyCode.Blazor.Components/README.md | 7 +++++++ AyCode.Blazor.Controllers/README.md | 7 +++++++ AyCode.Blazor.Models.Server/README.md | 7 +++++++ AyCode.Blazor.Models/README.md | 7 +++++++ AyCode.Maui.Core/README.md | 7 +++++++ 7 files changed, 45 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 7eb6fcb..a8d60ae 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,5 +1,11 @@ # AyCode.Blazor — Domain Rules +@repo { + type = "framework" + layer = 1 + own-dep-repos = ["AyCode.Core"] +} + > This is the **single source of truth** for Blazor/MAUI UI domain rules. Do not duplicate these elsewhere. > For core framework rules see: `../AyCode.Core/.github/copilot-instructions.md` > For detailed docs see: `README.md` → `docs/` diff --git a/AyCode.Blazor.Components.Tests/README.md b/AyCode.Blazor.Components.Tests/README.md index afd918f..bc073e4 100644 --- a/AyCode.Blazor.Components.Tests/README.md +++ b/AyCode.Blazor.Components.Tests/README.md @@ -1,5 +1,9 @@ # AyCode.Blazor.Components.Tests +@project { + type = "test" +} + bUnit + MSTest component test project targeting net10.0. Tests Blazor component behavior including grid layout persistence and column rendering. ## Key Files diff --git a/AyCode.Blazor.Components/README.md b/AyCode.Blazor.Components/README.md index 59b6bf4..e2bfcf4 100644 --- a/AyCode.Blazor.Components/README.md +++ b/AyCode.Blazor.Components/README.md @@ -1,5 +1,12 @@ # AyCode.Blazor.Components +@project { + type = "framework" + own-dep-projects = [ + "AyCode.Core, AyCode.Entities, AyCode.Interfaces, AyCode.Models, AyCode.Services, AyCode.Services.Server, AyCode.Utils (in AyCode.Core repo)" + ] +} + Blazor Razor component library targeting .NET 10. Provides reusable DevExpress-based UI components, a SignalR-powered grid system, and LINQ expression serialization services. ## Documentation diff --git a/AyCode.Blazor.Controllers/README.md b/AyCode.Blazor.Controllers/README.md index 63b36dd..d582fe4 100644 --- a/AyCode.Blazor.Controllers/README.md +++ b/AyCode.Blazor.Controllers/README.md @@ -1,5 +1,12 @@ # AyCode.Blazor.Controllers +@project { + type = "framework" + own-dep-projects = [ + "AyCode.Core, AyCode.Core.Server, AyCode.Database, AyCode.Entities, AyCode.Entities.Server, AyCode.Interfaces, AyCode.Interfaces.Server, AyCode.Models, AyCode.Models.Server, AyCode.Services, AyCode.Services.Server, AyCode.Utils (in AyCode.Core repo)" + ] +} + Scaffolding project for Blazor controllers and logging infrastructure. Currently contains only a placeholder class with a reserved folder for future logger implementations. ## Key Files diff --git a/AyCode.Blazor.Models.Server/README.md b/AyCode.Blazor.Models.Server/README.md index 720063a..fdb3c1d 100644 --- a/AyCode.Blazor.Models.Server/README.md +++ b/AyCode.Blazor.Models.Server/README.md @@ -1,5 +1,12 @@ # AyCode.Blazor.Models.Server +@project { + type = "framework" + own-dep-projects = [ + "AyCode.Core, AyCode.Core.Server, AyCode.Database, AyCode.Entities, AyCode.Entities.Server, AyCode.Interfaces, AyCode.Interfaces.Server, AyCode.Models.Server, AyCode.Services, AyCode.Services.Server, AyCode.Utils (in AyCode.Core repo)" + ] +} + Scaffolding project for server-side Blazor models and services. Currently contains only a placeholder class with reserved folders for future implementation. ## Key Files diff --git a/AyCode.Blazor.Models/README.md b/AyCode.Blazor.Models/README.md index b0033aa..6ac25d3 100644 --- a/AyCode.Blazor.Models/README.md +++ b/AyCode.Blazor.Models/README.md @@ -1,5 +1,12 @@ # AyCode.Blazor.Models +@project { + type = "framework" + own-dep-projects = [ + "AyCode.Core, AyCode.Core.Server, AyCode.Entities, AyCode.Entities.Server, AyCode.Interfaces, AyCode.Interfaces.Server, AyCode.Models, AyCode.Models.Server, AyCode.Services, AyCode.Services.Server, AyCode.Utils (in AyCode.Core repo)" + ] +} + .NET 10 class library with AOT compilation (`RunAOTCompilation` + `WasmStripILAfterAOT`) providing view model base classes and shared models for the AyCode Blazor UI layer. ## Key Files diff --git a/AyCode.Maui.Core/README.md b/AyCode.Maui.Core/README.md index 0410dae..6e07a71 100644 --- a/AyCode.Maui.Core/README.md +++ b/AyCode.Maui.Core/README.md @@ -1,5 +1,12 @@ # AyCode.Maui.Core +@project { + type = "framework" + own-dep-projects = [ + "AyCode.Core, AyCode.Entities, AyCode.Interfaces, AyCode.Models, AyCode.Services, AyCode.Utils (in AyCode.Core repo)" + ] +} + .NET MAUI class library targeting Android (API 33+), iOS (15.0+), and Windows (10.0.19041+). Provides cross-platform shared code with per-platform specialization via the `Platforms/` folder. ## Key Files