Skip to content

Add comprehensive AGENTS.md implementation reference#98

Merged
kzu merged 2 commits intomainfrom
copilot/create-project-design-documentation
Apr 14, 2026
Merged

Add comprehensive AGENTS.md implementation reference#98
kzu merged 2 commits intomainfrom
copilot/create-project-design-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 14, 2026

Creates AGENTS.md at the repo root as a dense implementation reference for agents (and contributors) working in the codebase.

Coverage

  • Repository layout – project roles table (StructId, StructId.Analyzer, StructId.CodeFix, tests, packaging)
  • Core interfacesIStructId, IStructId<TValue>, INewable<TSelf[,TValue]>, TStructIdAttribute, TValueAttribute
  • Generator architectureBaseGenerator pipeline and ReferenceCheck modes (ValueIsType vs TypeExists); TemplatedGenerator discovery/expansion flow; per-generator table with reference types, template files, and activation conditions
  • Template systemCodeTemplate.Apply mechanics, TemplateRewriter/ValueRewriter substitution rules (TSelf, TValue, prefixed variants), namespace injection, [TStructId] authoring rules and constraint patterns, [TValue] templates and TemplatizedTValueExtensions
  • Cacheable models – why StructIdModel/TemplateModel/TValueTemplateModel exist (no ISymbol/Compilation in pipeline), EquatableArray<T>, TrackingNames
  • Diagnostics & code fixes – SID001–SID005 with triggers and associated fix providers
  • Testing patternsStructIdGeneratorTest<TGenerator>, ReferenceAssemblies.Net.Net80, incrementality test conventions
  • Key design decisions – why readonly record struct, file-scoped templates, dev-only package, Scriban vs CodeTemplate (Dapper), ReferenceCheck semantics
  • New integration guide – step-by-step for adding a generator

@kzu
Copy link
Copy Markdown
Member

kzu commented Apr 14, 2026

81 passed 81 passed
81 passed 81 passed
81 passed 81 passed

🧪 Details on Ubuntu 24.04.4 LTS
🧪 Details on macOS Unix 15.7.4
🧪 Details on Microsoft Windows 10.0.26100

from retest v1.1.0 on .NET 10.0.5 with 💜 by @devlooped

Copilot AI changed the title [WIP] Add comprehensive project design and implementation documentation Add comprehensive AGENTS.md implementation reference Apr 14, 2026
Copilot finished work on behalf of kzu April 14, 2026 13:22
Copilot AI requested a review from kzu April 14, 2026 13:22
@kzu kzu marked this pull request as ready for review April 14, 2026 13:27
@kzu kzu enabled auto-merge (rebase) April 14, 2026 13:27
@kzu kzu added the documentation Improvements or additions to documentation label Apr 14, 2026
@kzu kzu merged commit b12cb0d into main Apr 14, 2026
6 checks passed
@kzu kzu deleted the copilot/create-project-design-documentation branch April 14, 2026 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create comprehensive project design and implementation documentation in AGENTS.md

2 participants