From fdff39c44b7ebb39ec4269c04a4c07826c20c331 Mon Sep 17 00:00:00 2001 From: Loretta Date: Mon, 30 Mar 2026 08:53:56 +0200 Subject: [PATCH] Add structured metadata blocks to all project/repo docs Added standardized metadata blocks to the top of each project and repo documentation file. These blocks define project type, and for repos, include layer and dependencies, improving clarity and enabling better tooling support. --- .github/copilot-instructions.md | 6 ++++++ AyCode.Core.Server/README.md | 4 ++++ AyCode.Core/README.md | 4 ++++ AyCode.Entities.Server/README.md | 4 ++++ AyCode.Entities/README.md | 4 ++++ AyCode.Interfaces.Server/README.md | 4 ++++ AyCode.Interfaces/README.md | 4 ++++ AyCode.Models.Server/README.md | 4 ++++ AyCode.Models/README.md | 4 ++++ AyCode.Services.Server.Tests/README.md | 4 ++++ AyCode.Services.Server/README.md | 4 ++++ AyCode.Services.Tests/README.md | 4 ++++ AyCode.Services/README.md | 4 ++++ AyCode.Utils.Server/README.md | 4 ++++ AyCode.Utils/README.md | 4 ++++ 15 files changed, 62 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index bb0e046..eea67f0 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,5 +1,11 @@ # AyCode.Core — Domain Rules +@repo { + type = "framework" + layer = 0 + own-dep-repos = [] +} + > This is the **single source of truth** for domain rules. Do not duplicate these elsewhere. > For detailed docs see: `README.md` → `docs/` diff --git a/AyCode.Core.Server/README.md b/AyCode.Core.Server/README.md index fa22d88..44eea8e 100644 --- a/AyCode.Core.Server/README.md +++ b/AyCode.Core.Server/README.md @@ -1,5 +1,9 @@ # AyCode.Core.Server +@project { + type = "framework" +} + Server-side extension of AyCode.Core. Provides server-specific implementations that build on the shared core library. ## Documentation diff --git a/AyCode.Core/README.md b/AyCode.Core/README.md index 0f1d538..36a7697 100644 --- a/AyCode.Core/README.md +++ b/AyCode.Core/README.md @@ -1,5 +1,9 @@ # AyCode.Core +@project { + type = "framework" +} + Core library for the AyCode platform. Targets .NET 9 (set in `AyCode.Core.targets`). Provides serialization (Binary, JSON, Toon), compression, logging, validation, and shared utilities. ## Documentation diff --git a/AyCode.Entities.Server/README.md b/AyCode.Entities.Server/README.md index 6433a31..ad4a264 100644 --- a/AyCode.Entities.Server/README.md +++ b/AyCode.Entities.Server/README.md @@ -1,5 +1,9 @@ # AyCode.Entities.Server +@project { + type = "framework" +} + Server-side entity implementations extending `AyCode.Entities`. Currently contains the database-persistable log item entity. ## Key Files diff --git a/AyCode.Entities/README.md b/AyCode.Entities/README.md index 9f81121..0142a84 100644 --- a/AyCode.Entities/README.md +++ b/AyCode.Entities/README.md @@ -1,5 +1,9 @@ # AyCode.Entities +@project { + type = "framework" +} + Abstract base entity implementations for the AyCode domain model. All entities are abstract and generic — concrete implementations live in application-specific projects. Implements the interfaces defined in `AyCode.Interfaces`. ## Folder Structure diff --git a/AyCode.Interfaces.Server/README.md b/AyCode.Interfaces.Server/README.md index 662e7a2..5402c9d 100644 --- a/AyCode.Interfaces.Server/README.md +++ b/AyCode.Interfaces.Server/README.md @@ -1,5 +1,9 @@ # AyCode.Interfaces.Server +@project { + type = "framework" +} + Server-side interface contracts extending `AyCode.Interfaces`. Defines authentication and login service contracts that are only relevant on the server. ## Key Files diff --git a/AyCode.Interfaces/README.md b/AyCode.Interfaces/README.md index a3a8da3..eedc9ae 100644 --- a/AyCode.Interfaces/README.md +++ b/AyCode.Interfaces/README.md @@ -1,5 +1,9 @@ # AyCode.Interfaces +@project { + type = "framework" +} + Domain interface contracts for the AyCode platform. Defines the shape of entities, DTOs, relationships, and service contracts. All interfaces are composable — small, single-responsibility interfaces are combined via inheritance to build up complex types. ## Folder Structure diff --git a/AyCode.Models.Server/README.md b/AyCode.Models.Server/README.md index 8471d34..2bc68d4 100644 --- a/AyCode.Models.Server/README.md +++ b/AyCode.Models.Server/README.md @@ -1,5 +1,9 @@ # AyCode.Models.Server +@project { + type = "framework" +} + Server-side models: authentication state and dynamic method dispatch for SignalR message routing. ## Folder Structure diff --git a/AyCode.Models/README.md b/AyCode.Models/README.md index 00fb0eb..921da8f 100644 --- a/AyCode.Models/README.md +++ b/AyCode.Models/README.md @@ -1,5 +1,9 @@ # AyCode.Models +@project { + type = "framework" +} + Shared DTOs (Data Transfer Objects) and view models for the AyCode platform. Bridges entities and interfaces into client/server-transferable models. ## Folder Structure diff --git a/AyCode.Services.Server.Tests/README.md b/AyCode.Services.Server.Tests/README.md index 3ebccd1..f4d3f30 100644 --- a/AyCode.Services.Server.Tests/README.md +++ b/AyCode.Services.Server.Tests/README.md @@ -1,5 +1,9 @@ # AyCode.Services.Server.Tests +@project { + type = "test" +} + Comprehensive server-side tests for SignalR communication, DataSource operations, login services, and reflection-based method invocation. ## Folder Structure diff --git a/AyCode.Services.Server/README.md b/AyCode.Services.Server/README.md index f7c0938..def4ff0 100644 --- a/AyCode.Services.Server/README.md +++ b/AyCode.Services.Server/README.md @@ -1,5 +1,9 @@ # AyCode.Services.Server +@project { + type = "framework" +} + Server-side service implementations: JWT authentication, SendGrid email delivery, SignalR hub infrastructure with binary protocol, session management, and change-tracked data sources. ## Documentation diff --git a/AyCode.Services.Tests/README.md b/AyCode.Services.Tests/README.md index 658aef9..f0ccf25 100644 --- a/AyCode.Services.Tests/README.md +++ b/AyCode.Services.Tests/README.md @@ -1,5 +1,9 @@ # AyCode.Services.Tests +@project { + type = "test" +} + MSTest project for service layer testing. Focuses on SignalR message serialization round-trips. ## Folder Structure diff --git a/AyCode.Services/README.md b/AyCode.Services/README.md index 088ba1f..34dcc22 100644 --- a/AyCode.Services/README.md +++ b/AyCode.Services/README.md @@ -1,5 +1,9 @@ # AyCode.Services +@project { + type = "framework" +} + Shared service implementations: SignalR communication (custom binary protocol), login services, and remote log writers. ## Documentation diff --git a/AyCode.Utils.Server/README.md b/AyCode.Utils.Server/README.md index f8a51d9..9a13d5e 100644 --- a/AyCode.Utils.Server/README.md +++ b/AyCode.Utils.Server/README.md @@ -1,5 +1,9 @@ # AyCode.Utils.Server +@project { + type = "framework" +} + Server-side utility library placeholder. Currently empty — reserved for future server-specific utilities. ## Dependencies diff --git a/AyCode.Utils/README.md b/AyCode.Utils/README.md index 679d610..ef34f57 100644 --- a/AyCode.Utils/README.md +++ b/AyCode.Utils/README.md @@ -1,5 +1,9 @@ # AyCode.Utils +@project { + type = "framework" +} + Low-level utility library with zero project dependencies. Provides string/datetime extensions, and disposable lock wrappers for `using` pattern with `Mutex`/`SemaphoreSlim`. ## Folder Structure