Skip to content

docs: Standardize BASELINE.md location across all ecosystem systems #304

Description

@kcenon

Summary

Standardize the location of BASELINE.md performance documentation to docs/performance/BASELINE.md across all ecosystem systems, eliminating inconsistency between benchmarks/ and docs/performance/ locations.

Background (Why)

  • BASELINE.md files exist in inconsistent locations across systems
  • Some systems have BASELINE.md in benchmarks/, others in docs/performance/
  • Some systems have duplicates in both locations
  • Inconsistent location makes it difficult to find performance documentation
  • Creates confusion for developers working across multiple systems

Current inconsistent locations:

common_system/        - docs/BENCHMARKS.md (no BASELINE.md)
thread_system/        - benchmarks/BASELINE.md, tests/benchmarks/BASELINE.md
logger_system/        - benchmarks/BASELINE.md
container_system/     - benchmarks/BASELINE.md
monitoring_system/    - benchmarks/BASELINE.md, docs/performance/BASELINE.md (DUPLICATE)
database_system/      - benchmarks/BASELINE.md, docs/performance/BASELINE.md (DUPLICATE)
network_system/       - BASELINE.md (root), benchmarks/BASELINE.md

Scope (What)

Current State

System benchmarks/BASELINE.md docs/performance/BASELINE.md Root BASELINE.md
common_system No No No
thread_system Yes (2 locations) No No
logger_system Yes No No
container_system Yes No No
monitoring_system Yes Yes (duplicate) No
database_system Yes Yes (duplicate) No
network_system Yes No Yes (duplicate)

Proposed State

System docs/performance/BASELINE.md benchmarks/README.md
All systems Primary location Link to docs/performance/

Standard Structure

<system>/
├── benchmarks/
│   ├── README.md            # Benchmark code documentation
│   └── (benchmark source files)
└── docs/
    └── performance/
        ├── BASELINE.md      # PRIMARY - Performance baseline results
        └── TUNING.md        # Performance tuning guide (if exists)

Impact Analysis (Where)

Files to Modify by System

System Action Source Target
thread_system Move benchmarks/BASELINE.md docs/performance/BASELINE.md
thread_system Delete tests/benchmarks/BASELINE.md - (duplicate)
logger_system Move benchmarks/BASELINE.md docs/performance/BASELINE.md
container_system Move benchmarks/BASELINE.md docs/performance/BASELINE.md
monitoring_system Merge benchmarks/BASELINE.md docs/performance/BASELINE.md
database_system Merge benchmarks/BASELINE.md docs/performance/BASELINE.md
network_system Consolidate root + benchmarks/ docs/performance/BASELINE.md

Cross-Reference Updates

For each system:

  • Update benchmarks/README.md to link to docs/performance/BASELINE.md
  • Update any README.md references to BASELINE.md location
  • Update CI/CD workflows that reference BASELINE.md

Implementation Plan (How)

Phase 1: Create Target Directories

  1. Ensure docs/performance/ directory exists in all systems
  2. Create directory if missing

Phase 2: thread_system

  1. Move benchmarks/BASELINE.md to docs/performance/BASELINE.md
  2. Delete tests/benchmarks/BASELINE.md (duplicate)
  3. Update benchmarks/README.md with link

Phase 3: logger_system

  1. Move benchmarks/BASELINE.md to docs/performance/BASELINE.md
  2. Update benchmarks/README.md with link

Phase 4: container_system

  1. Move benchmarks/BASELINE.md to docs/performance/BASELINE.md
  2. Update benchmarks/README.md with link

Phase 5: monitoring_system

  1. Compare both BASELINE.md files
  2. Merge unique content into docs/performance/BASELINE.md
  3. Delete benchmarks/BASELINE.md
  4. Update benchmarks/README.md with link

Phase 6: database_system

  1. Compare both BASELINE.md files
  2. Merge unique content into docs/performance/BASELINE.md
  3. Delete benchmarks/BASELINE.md
  4. Update benchmarks/README.md with link

Phase 7: network_system

  1. Consolidate root and benchmarks/ BASELINE.md
  2. Move to docs/performance/BASELINE.md
  3. Delete duplicates
  4. Update references

Phase 8: Verification

  1. Verify BASELINE.md exists in docs/performance/ for all systems
  2. Verify no duplicate BASELINE.md files remain
  3. Verify all links are updated

Acceptance Criteria

  • All systems have BASELINE.md in docs/performance/
  • No BASELINE.md in benchmarks/ directory (only links)
  • No BASELINE.md at root level in any system
  • All benchmarks/README.md files link to correct location
  • All main README.md files have correct BASELINE.md links
  • No duplicate BASELINE.md files
  • CI/CD workflows updated if they reference BASELINE.md

Related Issues

Labels

  • documentation
  • enhancement
  • standardization

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestepicEpic issue tracking multiple sub-tasks

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions