Documentation Map

This guide helps you navigate the documentation available in the v4-monorepo. Each document serves a specific purpose and is aimed at different audiences.

Core Documentation

Document	Purpose	Target Audience	Location
README.md	Project overview, quick start, architecture	New developers, Project overview	Root
CLAUDE.md	Development guidelines, code style, best practices	Active developers	Root
CONTRIBUTING.md	Contribution workflow and guidelines	Contributors	Root

Specialized Documentation

For New Developers

• README Template - Template for project-specific READMEs
• Visual Documentation - Diagrams and visual guides
• Directory Map - Repository directory structure

For Active Developers

• Command Reference - Comprehensive command documentation
• CI/CD Guide - CI/CD pipeline documentation
• NX Affected Guide - Guide to working with NX affected commands

Technology Primers

• Technology guides are available in the guides directory - NX monorepo concepts and workflows
• Technology guides are available in the guides directory - Yarn workspaces management
• Technology guides are available in the guides directory - Python dependency management
• Technology guides are available in the guides directory - TypeScript configuration
• Technology guides are available in the guides directory - Docker multi-stage builds
• Technology guides are available in the guides directory - CI/CD processes

Migration & Strategy Guides

• Jest to Vitest Migration - Migration guide
• Shared Libraries Migration - Migration guide
• NX Tag Strategy - Tagging strategy

Architecture Decision Records (ADRs)

• ADR Directory - All architecture decision records
• Stricter TypeScript Configuration
• Standardized Build Policy
• NX Configuration Optimization

Documentation Structure

v4-monorepo/
├── README.md                                    # Project overview and quick start
├── CLAUDE.md                                    # Development guidelines and best practices
├── CONTRIBUTING.md                              # Contribution guidelines
└── documentation/                               # Detailed documentation directory
    ├── README.md                                # Documentation overview
    ├── documentation-map.md                     # Documentation navigation guide
    ├── adr/                                     # Architecture Decision Records
    ├── branch-mgmt/                             # Branch management documentation
    ├── bqSchema/                                # BigQuery schema documentation
    ├── diagrams/                                # Detailed service diagrams
    ├── examples/                                # Example documentation files
    ├── guides/                                  # How-to guides and tutorials
    │   ├── building/                            # Building and deployment guides
    │   │   └── ci-cd-guide.md                   # CI/CD pipeline guide
    │   ├── development/                         # Development workflow guides
    │   │   ├── nx-affected-guide.md             # NX affected commands guide
    │   │   └── nx-tag-strategy.md               # NX tag strategy guide
    │   └── migration/                           # Migration guides
    │       ├── migrating-jest-to-vitest.md      # Jest to Vitest migration guide
    │       └── shared-libs-migration.md         # Shared libraries migration plan
    ├── planning/                                # Documentation planning
    │   ├── consolidation-plan.md                # Documentation consolidation plan
    │   ├── consolidation-summary.md             # Documentation consolidation summary
    │   ├── documentation-improvement-plan.md    # Documentation improvement plan
    │   └── readme-standardization-implementation-plan.md # README standardization plan
    ├── primers/                                 # Technology primers
    ├── reference/                               # Reference documentation
    │   ├── api/                                 # API documentation
    │   │   └── orderbook.openapi.yaml           # Orderbook API specification
    │   ├── architecture/                        # Architecture documentation
    │   │   ├── directory-map.md                 # Repository structure map
    │   │   └── visual-documentation.md          # Visual documentation
    │   └── commands/                            # Command documentation
    │       └── command-reference.md             # Comprehensive command reference
    ├── standards/                               # Standards documentation
    │   └── readme-standardization-guide.md      # README standardization guide
    ├── templates/                               # Documentation templates
    └── tools/                                   # Tools documentation
        └── tools-categorization.md              # Tools categorization

Documentation Plans and Standards

• Documentation planning - Comprehensive plan for documentation improvements
• Documentation planning - Plan for reducing duplication and inconsistencies
• README Standardization Guide - Guidelines for standardized project READMEs

Contributing to Documentation

When contributing to documentation, please follow these guidelines:

1. Single Source of Truth: Avoid duplicating information across multiple files
2. Cross-References: Use clear cross-references between related documents
3. Clear Purpose: Each document should have a clear, specific purpose
4. Target Audience: Consider the audience for each document and adjust detail level
5. Consistency: Maintain consistent formatting and terminology
6. Updates: When updating code, update the corresponding documentation