From 541cebbed86e78d23d26239075e1ffdeb3ab61e9 Mon Sep 17 00:00:00 2001 From: Loretta Date: Mon, 30 Mar 2026 08:01:05 +0200 Subject: [PATCH] Update README links to use code-style paths for docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replaced Markdown links with plain code-style paths in all README.md files for consistency. Updated references to logging, SignalR, and dynamic method dispatch documentation. Clarified some documentation paths and improved consistency in context/architecture sections. No code changes—documentation only. --- AyCode.Core.Server/Loggers/README.md | 2 +- AyCode.Core/Loggers/README.md | 4 ++-- AyCode.Database/DbContexts/Loggers/README.md | 2 +- AyCode.Database/DbSets/Loggers/README.md | 2 +- AyCode.Entities.Server/LogItems/README.md | 2 +- AyCode.Entities/LogItems/README.md | 2 +- AyCode.Models.Server/DynamicMethods/README.md | 2 +- AyCode.Services.Server/SignalRs/README.md | 4 ++-- AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md | 2 +- AyCode.Services.Server/docs/SIGNALR_SERVER.md | 2 +- AyCode.Services/Loggers/README.md | 2 +- AyCode.Services/SignalRs/README.md | 4 ++-- README.md | 2 +- 13 files changed, 16 insertions(+), 16 deletions(-) diff --git a/AyCode.Core.Server/Loggers/README.md b/AyCode.Core.Server/Loggers/README.md index 2c56143..82d2e51 100644 --- a/AyCode.Core.Server/Loggers/README.md +++ b/AyCode.Core.Server/Loggers/README.md @@ -2,7 +2,7 @@ Server-side singleton logger for static access across the application. -> For full logging architecture see [`docs/LOGGING.md`](../../docs/LOGGING.md). For core logger and writer abstractions see [`AyCode.Core/Loggers/README.md`](../../AyCode.Core/Loggers/README.md). +> For full logging architecture see `docs/LOGGING.md`. For core logger and writer abstractions see `AyCode.Core/Loggers/README.md`. ## Key Files diff --git a/AyCode.Core/Loggers/README.md b/AyCode.Core/Loggers/README.md index 8e4beda..8aea4f9 100644 --- a/AyCode.Core/Loggers/README.md +++ b/AyCode.Core/Loggers/README.md @@ -2,7 +2,7 @@ Custom logging framework with multi-writer fan-out and `Microsoft.Extensions.Logging` integration. This directory contains the **core** logger and writer abstractions — the defining layer for the logging system. -> For full architecture, configuration, all writers, and remote logging flow see [`docs/LOGGING.md`](../../docs/LOGGING.md). +> For full architecture, configuration, all writers, and remote logging flow see `docs/LOGGING.md`. ## Architecture @@ -18,7 +18,7 @@ IAcLogWriterBase └─ [AcLogItemWriterBase in AyCode.Entities — structured writers] ``` -**Two-level filtering:** Logger has a global `LogLevel` gate; each writer has its own `LogLevel`. Both must pass for a log entry to be written. See [`docs/LOGGING.md` → Design Overview](../../docs/LOGGING.md#design-overview). +**Two-level filtering:** Logger has a global `LogLevel` gate; each writer has its own `LogLevel`. Both must pass for a log entry to be written. See `docs/LOGGING.md` → Design Overview. ## Key Files diff --git a/AyCode.Database/DbContexts/Loggers/README.md b/AyCode.Database/DbContexts/Loggers/README.md index f7a35be..4590f51 100644 --- a/AyCode.Database/DbContexts/Loggers/README.md +++ b/AyCode.Database/DbContexts/Loggers/README.md @@ -2,7 +2,7 @@ Logger-specific EF Core DbContext with `NoTracking` query behavior for read performance. Used by `AcDbLogItemWriter` to persist log items. -> For full logging architecture see [`docs/LOGGING.md`](../../../../docs/LOGGING.md). +> For full logging architecture see `docs/LOGGING.md`. ## Key Files diff --git a/AyCode.Database/DbSets/Loggers/README.md b/AyCode.Database/DbSets/Loggers/README.md index e6d16e8..709c1ac 100644 --- a/AyCode.Database/DbSets/Loggers/README.md +++ b/AyCode.Database/DbSets/Loggers/README.md @@ -2,7 +2,7 @@ Log item DbSet interface for EF Core log storage. -> For full logging architecture see [`docs/LOGGING.md`](../../../../docs/LOGGING.md). +> For full logging architecture see `docs/LOGGING.md`. ## Key Files diff --git a/AyCode.Entities.Server/LogItems/README.md b/AyCode.Entities.Server/LogItems/README.md index 3d82159..f54efc8 100644 --- a/AyCode.Entities.Server/LogItems/README.md +++ b/AyCode.Entities.Server/LogItems/README.md @@ -2,7 +2,7 @@ Server-side log item entity and interface, extending the client-side `AcLogItemClient` with database-mapped identity and header reference. -> For full logging architecture see [`docs/LOGGING.md`](../../docs/LOGGING.md). For client-side entity see [`AyCode.Entities/LogItems/README.md`](../../AyCode.Entities/LogItems/README.md). +> For full logging architecture see `docs/LOGGING.md`. For client-side entity see `AyCode.Entities/LogItems/README.md`. ## Key Files diff --git a/AyCode.Entities/LogItems/README.md b/AyCode.Entities/LogItems/README.md index edc60a0..0cad923 100644 --- a/AyCode.Entities/LogItems/README.md +++ b/AyCode.Entities/LogItems/README.md @@ -2,7 +2,7 @@ Client-side log item entity used for structured logging. Serialized with MessagePack for efficient transport over SignalR. -> For full logging architecture see [`docs/LOGGING.md`](../../docs/LOGGING.md). +> For full logging architecture see `docs/LOGGING.md`. ## Key Files diff --git a/AyCode.Models.Server/DynamicMethods/README.md b/AyCode.Models.Server/DynamicMethods/README.md index 33c81cd..41be223 100644 --- a/AyCode.Models.Server/DynamicMethods/README.md +++ b/AyCode.Models.Server/DynamicMethods/README.md @@ -3,7 +3,7 @@ Reflection-based infrastructure for dynamically dispatching method calls by message tag, primarily used for SignalR message routing. > **Context:** This is the server-side dispatch engine for the SignalR tag-based architecture. -> See [`docs/SIGNALR.md`](../../docs/SIGNALR.md) for the full message flow. +> See `AyCode.Services.Server/docs/SIGNALR_SERVER.md` for the full message flow. ## How It Fits diff --git a/AyCode.Services.Server/SignalRs/README.md b/AyCode.Services.Server/SignalRs/README.md index 0fdd713..dc558a6 100644 --- a/AyCode.Services.Server/SignalRs/README.md +++ b/AyCode.Services.Server/SignalRs/README.md @@ -2,7 +2,7 @@ Server-side SignalR hub infrastructure: hub base class, session management, data source with change tracking, and client broadcast service. -> **Architecture:** For full dispatch flow, tag system, and tech debt documentation see [`docs/SIGNALR.md`](../../docs/SIGNALR.md). +> **Architecture:** For full dispatch flow, tag system, and tech debt documentation see `AyCode.Services/docs/SIGNALR.md`. ## Key Files @@ -18,7 +18,7 @@ Server-side SignalR hub infrastructure: hub base class, session management, data ### Data Source -> **Full specification:** [`docs/SIGNALR_DATASOURCE.md`](../../docs/SIGNALR_DATASOURCE.md) +> **Full specification:** `AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md` - **`AcSignalRDataSource.cs`** — Generic real-time collection (`AcSignalRDataSource`) implementing `IList` with full CRUD and change tracking. - **Change tracking:** `TrackingItem` wraps each modified item with `TrackingState` + `OriginalValue` for rollback. `ChangeTracking` manages the tracking list. diff --git a/AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md b/AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md index d1efedb..062875b 100644 --- a/AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md +++ b/AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md @@ -177,7 +177,7 @@ DataSource.SaveChanges() → Server method with [SignalR(tag)] ← tag dispatch ``` -Projects can also call the transport directly without DataSource — see [`AyCode.Services/docs/SIGNALR.md`](../../AyCode.Services/docs/SIGNALR.md). +Projects can also call the transport directly without DataSource — see `AyCode.Services/docs/SIGNALR.md`. ## Key Source Files diff --git a/AyCode.Services.Server/docs/SIGNALR_SERVER.md b/AyCode.Services.Server/docs/SIGNALR_SERVER.md index fb51d17..b079d1c 100644 --- a/AyCode.Services.Server/docs/SIGNALR_SERVER.md +++ b/AyCode.Services.Server/docs/SIGNALR_SERVER.md @@ -23,7 +23,7 @@ Server-side SignalR hub infrastructure: method dispatch, session management, bro ## Dynamic Method Dispatch -See also: [`AyCode.Models.Server/DynamicMethods/README.md`](../../AyCode.Models.Server/DynamicMethods/README.md) +See also: `AyCode.Models.Server/DynamicMethods/README.md` ### Server-Side Lookup diff --git a/AyCode.Services/Loggers/README.md b/AyCode.Services/Loggers/README.md index acbd623..dac0b38 100644 --- a/AyCode.Services/Loggers/README.md +++ b/AyCode.Services/Loggers/README.md @@ -2,7 +2,7 @@ Remote log writers for sending log items over HTTP, SignalR, or to the browser console. All three implement `IAcLogWriterClientBase`. -> For full logging architecture see [`docs/LOGGING.md`](../../docs/LOGGING.md). For core logger and writer abstractions see [`AyCode.Core/Loggers/README.md`](../../AyCode.Core/Loggers/README.md). +> For full logging architecture see `docs/LOGGING.md`. For core logger and writer abstractions see `AyCode.Core/Loggers/README.md`. ## Key Files diff --git a/AyCode.Services/SignalRs/README.md b/AyCode.Services/SignalRs/README.md index 4d63f1f..d88ca9e 100644 --- a/AyCode.Services/SignalRs/README.md +++ b/AyCode.Services/SignalRs/README.md @@ -2,7 +2,7 @@ Custom binary SignalR protocol, client infrastructure, message tagging, and serialization helpers. -> **Architecture:** For full dispatch flow, tag system, and tech debt documentation see [`docs/SIGNALR.md`](../../docs/SIGNALR.md). +> **Architecture:** For full dispatch flow, tag system, and tech debt documentation see `AyCode.Services/docs/SIGNALR.md`. ## Key Files @@ -17,7 +17,7 @@ Custom binary SignalR protocol, client infrastructure, message tagging, and seri ### Message Tagging - **`SignalMessageTagAttribute.cs`** — Three attributes: `TagAttribute` (base, int messageTag), `SignalRAttribute` (server method routing + client notification), `SignalRSendToClientAttribute` (client-side receive). - **`AcSignalRTags.cs`** — Static constants: `None`, `PingTag`, `EchoTag`. -- **`SignalRCrudTags.cs`** — Sealed class bundling 5 independent CRUD tag integers. `GetMessageTagByTrackingState()` maps `TrackingState` → tag. See [`docs/SIGNALR_DATASOURCE.md`](../../docs/SIGNALR_DATASOURCE.md). +- **`SignalRCrudTags.cs`** — Sealed class bundling 5 independent CRUD tag integers. `GetMessageTagByTrackingState()` maps `TrackingState` → tag. See `AyCode.Services.Server/docs/SIGNALR_DATASOURCE.md`. - **`SendToClientType.cs`** — Enum: None, Others, Caller, All. ### Serialization & Pooling diff --git a/README.md b/README.md index 17af137..1fad42e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## LLM Context -Domain rules and key pitfalls live in a single file: [`.github/copilot-instructions.md`](.github/copilot-instructions.md) +Domain rules and key pitfalls live in a single file: `.github/copilot-instructions.md` | Tool | Auto-loaded | Action needed | |------|------------|---------------|