Loretta
cdcb200643
- Introduced `.github/copilot-instructions.md` as the single source of truth for domain rules, conventions, and pitfalls in each solution. - Added `CLAUDE.md` to guide Claude to read domain rules, glossary, and README before code generation. - Updated all solution and project `README.md` files to document project purpose, structure, key files, and LLM context (Copilot/Claude/Cursor). - Added or revised `docs/ARCHITECTURE.md`, `docs/CONVENTIONS.md`, and `docs/GLOSSARY.md` to clarify dependency graphs, naming, patterns, and terminology. - For FruitBankHybridApp, added `docs/SCHEMA.md` (Toon format) and expanded the glossary with business/measurement terms and common traps. - Updated all subfolder READMEs to list key files, conventions, and LLM maintenance notes. - Ensured all documentation is cross-referenced, up-to-date, and includes explicit instructions for LLMs to keep docs in sync with code and avoid suggesting removal/rollback as a solution. - Standardized documentation and onboarding for maintainability and LLM/code quality across all solutions. |
||
|---|---|---|
| .claude | ||
| .github | ||
| AyCode.Benchmark | ||
| AyCode.Core | ||
| AyCode.Core.Serializers.Console | ||
| AyCode.Core.Serializers.SourceGenerator | ||
| AyCode.Core.Server | ||
| AyCode.Core.Tests | ||
| AyCode.Core.Tests.Internal | ||
| AyCode.Database | ||
| AyCode.Database.Tests | ||
| AyCode.Database.Tests.Internal | ||
| AyCode.Entities | ||
| AyCode.Entities.Server | ||
| AyCode.Interfaces | ||
| AyCode.Interfaces.Server | ||
| AyCode.Models | ||
| AyCode.Models.Server | ||
| AyCode.Services | ||
| AyCode.Services.Server | ||
| AyCode.Services.Server.Tests | ||
| AyCode.Services.Tests | ||
| AyCode.Utils | ||
| AyCode.Utils.Server | ||
| docs | ||
| .gitattributes | ||
| .gitignore | ||
| .plan | ||
| AllBenchmarksDropdown.html | ||
| AyCode.Core.sln | ||
| AyCode.Core.targets | ||
| CLAUDE.md | ||
| Directory.Build.props | ||
| MergeBenchmarksHtmlDropdown.bat | ||
| MergeBenchmarksHtmlDropdown.ps1 | ||
| README.md | ||
| RunFullBenchmark.bat | ||
| RunQuickBenchmark.bat | ||
| RunQuickBenchmark.ps1 | ||
| TestChainApi.cs | ||
| ToonExtendedInfo.txt | ||
| test.runsettings | ||
README.md
AyCode.Core Solution
.NET 10 core framework providing serialization (Binary, JSON, Toon), entity abstractions, database access, services, and shared utilities. Used as the foundation layer for AyCode applications.
LLM Context
Domain rules and key pitfalls live in a single file: .github/copilot-instructions.md
| Tool | Auto-loaded | Action needed |
|---|---|---|
| GitHub Copilot | ✅ copilot-instructions.md |
None |
| Claude Code | ✅ CLAUDE.md → references above |
None |
| Cursor / Windsurf | ✅ README.md |
Read copilot-instructions.md via @file |
Detailed docs: docs/ — GLOSSARY.md, ARCHITECTURE.md, CONVENTIONS.md
Solution Structure
| Project | Purpose | README |
|---|---|---|
AyCode.Core |
Core library: serializers, compression, logging, validation | README |
AyCode.Core.Server |
Server-side core extensions (GlobalLogger) | README |
AyCode.Core.Serializers.SourceGenerator |
Roslyn source generator for binary serializers | README |
AyCode.Core.Serializers.Console |
Serializer benchmark console app | README |
AyCode.Interfaces |
Entity interfaces: IId, IForeignKey, profiles, addresses | README |
AyCode.Interfaces.Server |
Server-side interfaces (login services) | README |
AyCode.Entities |
Abstract entity base classes (User, Profile, Address, Company) | README |
AyCode.Entities.Server |
Server-side entities (LogItem) | README |
AyCode.Models |
DTOs and view models | README |
AyCode.Models.Server |
Server-side models (Login, DynamicMethods) | README |
AyCode.Services |
Client-side services (SignalR, logging, login) | README |
AyCode.Services.Server |
Server-side services (SignalR hub, email, login) | README |
AyCode.Database |
EF Core data access layer with DAL pattern | README |
AyCode.Utils |
Zero-dependency utilities (string, datetime, lock wrappers) | README |
AyCode.Utils.Server |
Server-side utilities (placeholder) | README |
Test & Benchmark Projects
| Project | Purpose | README |
|---|---|---|
AyCode.Benchmark |
BenchmarkDotNet performance suite | README |
AyCode.Core.Tests |
Serialization, compression, and utility tests | README |
AyCode.Core.Tests.Internal |
Internal entity implementations for DB tests | README |
AyCode.Database.Tests |
Database layer test base classes | README |
AyCode.Database.Tests.Internal |
Concrete database integration tests | README |
AyCode.Services.Tests |
Service layer tests | README |
AyCode.Services.Server.Tests |
Server-side SignalR and service tests | README |
LLM Maintenance: If you modify this solution's structure, 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.