Skip to content

docs: Create CLAUDE.md for all ecosystem projects #560

Description

@kcenon

What

Create CLAUDE.md files for all 8 ecosystem projects to provide AI development
context. This is the highest-impact documentation improvement — it directly
enhances AI-assisted development productivity.

Why

All 8 projects lack CLAUDE.md. When using AI tools (Claude Code, Copilot, etc.),
the absence of structured project context forces repeated manual explanation of
architecture, patterns, and constraints. A well-structured CLAUDE.md accelerates
AI-assisted workflows significantly.

Where

Repository File Action
common_system CLAUDE.md Add
thread_system CLAUDE.md Add
logger_system CLAUDE.md Add
container_system CLAUDE.md Add
monitoring_system CLAUDE.md Add
database_system CLAUDE.md Add
network_system CLAUDE.md Add
pacs_system CLAUDE.md Add

How

Each CLAUDE.md should follow this standard structure:

# {project_name}

## Overview
{Project purpose and core design philosophy — 1-2 sentences}

## Architecture
{Core module structure, dependency direction, key abstractions}

## Build & Test
{Build commands, test execution, CI configuration}

## Key Patterns
{Project-specific patterns: Result<T>, decorator, facade, RAII, etc.}

## Ecosystem Position
{Tier level, upstream/downstream dependencies}

## Dependencies
{External dependencies and ecosystem dependencies}

## Known Constraints
{Platform limitations, experimental features, breaking change warnings}

Per-Project Key Content

Project Tier Key Patterns to Document
common_system 0 Header-only, Result, value types, type_traits
thread_system 1 Thread pool, queue strategies, priority scheduling
container_system 1 Type-safe containers, SIMD optimization, value_types
logger_system 2 Decorator pattern, async writers, OpenTelemetry
monitoring_system 2 Collector factory, metrics pipeline, distributed tracing
database_system 3 Multi-backend abstraction, ORM, query builder
network_system 4 Facade API, protocol modules, coroutine-based I/O
pacs_system 5 DICOM layers, SOP classes, transfer syntax

Acceptance Criteria

  • CLAUDE.md exists in all 8 project roots
  • Each file follows the standard structure above
  • Ecosystem position and tier level documented
  • Key patterns specific to each project are captured
  • Build & test commands are verified to work

Related

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions