Skip to content

Consolidate and organize TypeScript documentation #20

@ballidev

Description

@ballidev

Problem

We have too many documentation files in the cc-commands-ts project, making it confusing to know where to find information.

Current Documentation Files

  • CLAUDE.md
  • CLAUDE/Architecture.md
  • CLAUDE/OrchestratorArchitecture.md
  • CLAUDE/ServiceArchitecture.md
  • README.md

Proposed Solution

Consolidate into exactly 3 authoritative documents:

1. ARCHITECTURE.md

  • Core principles (commands are markdown, TypeScript is a tool)
  • Service layers and contracts (IOrchestrationService)
  • Directory structure
  • Dependency injection patterns
  • What goes where and why

2. CODING_STANDARDS.md

  • TypeScript configuration
  • ESLint rules and why they exist
  • FAIL FAST principle
  • Error handling patterns
  • Naming conventions
  • Import/export patterns

3. TESTING_STANDARDS.md

  • Test structure and organization
  • Mocking strategies
  • Coverage requirements
  • Test-first development process
  • Integration vs unit tests

Acceptance Criteria

  • All existing documentation consolidated into 3 files
  • No duplicate information
  • Clear hierarchy and navigation
  • Each file has a clear purpose
  • Old files removed or archived

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions