Adding Technology Documentation

Technology docs in common/technology/ encode rules for specific libraries and tools. Agents reference these when implementing code.

File Format

Create a new .md file in common/technology/:

# Technology Name Rules

## Purpose

Brief description of what this technology is used for in the project.

## When to Use

- Specific scenarios where this technology applies
- What it replaces or complements

## Configuration / Usage Pattern

Code examples showing the standard usage pattern.

## Rules

- Bullet list of rules that agents must follow
- Include both "do" and "don't" guidance

Categories

Category Examples
Module-level libraries EF Core, Marten, Wolverine, FluentValidation
Cross-module libraries Vogen, SmartEnum, Ardalis.Specification
Host infrastructure Aspire, Serilog, Sentry, Redis, TickerQ

After Adding

  1. Update the relevant agent’s ## Reference Documents section to include the new file
  2. Update CLAUDE.md if the technology is significant enough to mention
  3. If it affects the layer dependency rules, update common/architecture/layer-dependency-rules.md

This site uses Just the Docs, a documentation theme for Jekyll.