Skip to content

Trim down claude.md / add module-specific documentation#58

Merged
ssweber merged 14 commits intomainfrom
repomap
Jan 17, 2026
Merged

Trim down claude.md / add module-specific documentation#58
ssweber merged 14 commits intomainfrom
repomap

Conversation

@ssweber
Copy link
Owner

@ssweber ssweber commented Jan 17, 2026

No description provided.

  The main CLAUDE.md is now a concise high-level overview containing:
  - Project Overview
  - Prerequisites
  - Build & Development Commands
  - NEW: Using RepoMapper for Context section with practical examples
  - Entry Points
  - Package Structure diagram
  - High-level architectural patterns (Unidirectional Data Flow, Static Skeleton, Observer
  Pattern)
  - Links to module-specific READMEs
  - Key Dependencies
  - Testing overview

  7 New Module README Files Created

  1. src/clicknick/models/README.md - Data models, validation, Block Tag Specification
  2. src/clicknick/data/README.md - Shared state architecture, edit sessions, observer pattern,
  data flows
  3. src/clicknick/services/README.md - Business logic layer, service principles, operation
  examples
  4. src/clicknick/utils/README.md - Filter system with abbreviation matching, MDB operations,
  Win32 utilities
  5. src/clicknick/views/README.md - UI architecture, passive observers, Address Editor details,
  Tag Browser Logic
  6. src/clicknick/widgets/README.md - Reusable UI components catalog
  7. src/clicknick/detection/README.md - Window detection patterns, CLICK integration

  Verification Results

  - All original content preserved and moved to appropriate module READMEs
  - CLAUDE.md is now 29% shorter (198 vs 280 lines)
  - Each module now has focused, detailed documentation
  - Better separation of concerns and easier navigation
  - RepoMapper usage documentation added as requested
@ssweber ssweber merged commit 84b2b12 into main Jan 17, 2026
3 checks passed
@ssweber ssweber deleted the repomap branch January 17, 2026 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant