Update README links to use code-style paths for docs
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.
This commit is contained in:
parent
cb97b33ca0
commit
541cebbed8
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Server-side singleton logger for static access across the application.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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.
|
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
|
## Architecture
|
||||||
|
|
||||||
|
|
@ -18,7 +18,7 @@ IAcLogWriterBase
|
||||||
└─ [AcLogItemWriterBase<T> in AyCode.Entities — structured writers]
|
└─ [AcLogItemWriterBase<T> 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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Logger-specific EF Core DbContext with `NoTracking` query behavior for read performance. Used by `AcDbLogItemWriter` to persist log items.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Log item DbSet interface for EF Core log storage.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Server-side log item entity and interface, extending the client-side `AcLogItemClient` with database-mapped identity and header reference.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Client-side log item entity used for structured logging. Serialized with MessagePack for efficient transport over SignalR.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
Reflection-based infrastructure for dynamically dispatching method calls by message tag, primarily used for SignalR message routing.
|
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.
|
> **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
|
## How It Fits
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Server-side SignalR hub infrastructure: hub base class, session management, data source with change tracking, and client broadcast service.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
@ -18,7 +18,7 @@ Server-side SignalR hub infrastructure: hub base class, session management, data
|
||||||
|
|
||||||
### Data Source
|
### 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<TDataItem, TId, TIList>`) implementing `IList<T>` with full CRUD and change tracking.
|
- **`AcSignalRDataSource.cs`** — Generic real-time collection (`AcSignalRDataSource<TDataItem, TId, TIList>`) implementing `IList<T>` with full CRUD and change tracking.
|
||||||
- **Change tracking:** `TrackingItem<T, TId>` wraps each modified item with `TrackingState` + `OriginalValue` for rollback. `ChangeTracking<T, TId>` manages the tracking list.
|
- **Change tracking:** `TrackingItem<T, TId>` wraps each modified item with `TrackingState` + `OriginalValue` for rollback. `ChangeTracking<T, TId>` manages the tracking list.
|
||||||
|
|
|
||||||
|
|
@ -177,7 +177,7 @@ DataSource.SaveChanges()
|
||||||
→ Server method with [SignalR(tag)] ← tag dispatch
|
→ 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
|
## Key Source Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ Server-side SignalR hub infrastructure: method dispatch, session management, bro
|
||||||
|
|
||||||
## Dynamic Method Dispatch
|
## 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
|
### Server-Side Lookup
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Remote log writers for sending log items over HTTP, SignalR, or to the browser console. All three implement `IAcLogWriterClientBase`.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Custom binary SignalR protocol, client infrastructure, message tagging, and serialization helpers.
|
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
|
## Key Files
|
||||||
|
|
||||||
|
|
@ -17,7 +17,7 @@ Custom binary SignalR protocol, client infrastructure, message tagging, and seri
|
||||||
### Message Tagging
|
### Message Tagging
|
||||||
- **`SignalMessageTagAttribute.cs`** — Three attributes: `TagAttribute` (base, int messageTag), `SignalRAttribute` (server method routing + client notification), `SignalRSendToClientAttribute` (client-side receive).
|
- **`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`.
|
- **`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.
|
- **`SendToClientType.cs`** — Enum: None, Others, Caller, All.
|
||||||
|
|
||||||
### Serialization & Pooling
|
### Serialization & Pooling
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
|
|
||||||
## LLM Context
|
## 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 |
|
| Tool | Auto-loaded | Action needed |
|
||||||
|------|------------|---------------|
|
|------|------------|---------------|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue