Added comprehensive README.md documentation to every project and subfolder in the solution. Each README describes the purpose, key files, structure, dependencies, and design patterns for its area. This improves codebase navigability and maintainability, and includes a maintenance note to keep docs in sync with future code changes. |
||
|---|---|---|
| .. | ||
| LogItems | ||
| AyCode.Entities.Server.csproj | ||
| README.md | ||
README.md
AyCode.Entities.Server
Server-side entity implementations extending AyCode.Entities. Currently contains the database-persistable log item entity.
Key Files
LogItems/
IAcLogItem.cs— Interface extendingIAcLogItemClient+IEntityInt. Addsint LogHeaderIdfor log header foreign key.AcLogItem.cs— Concrete log item entity mapped to[Table("LogItem")]. InheritsAcLogItemClient, implementsIAcLogItem. Auto-incrementint Idprimary key. MessagePack-serializable with[MessagePackObject].
Dependencies
| Dependency | Purpose |
|---|---|
AyCode.Core |
Enums, loggers |
AyCode.Entities |
AcLogItemClient base class |
AyCode.Utils |
Shared utilities |
MessagePack.Annotations |
[MessagePackObject], [Key] for serialization |
LLM Maintenance: If you modify code in this folder, update this README to reflect the changes. If you notice the README content does not match the current code, automatically update the README to match the code.